Defined new structure for tracking config, together with new options

module/Core/src/Action/AbstractTrackingAction.php

@@ -18,7 +18,7 @@ use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Exception\ShortUrlNotFoundException;
 use Shlinkio\Shlink\Core\Model\ShortUrlIdentifier;
 use Shlinkio\Shlink\Core\Model\Visitor;
-use Shlinkio\Shlink\Core\Options\AppOptions;
+use Shlinkio\Shlink\Core\Options\TrackingOptions;
 use Shlinkio\Shlink\Core\Service\ShortUrl\ShortUrlResolverInterface;
 use Shlinkio\Shlink\Core\Visit\VisitsTrackerInterface;
 
@@ -29,18 +29,18 @@ abstract class AbstractTrackingAction implements MiddlewareInterface, RequestMet
 {
     private ShortUrlResolverInterface $urlResolver;
     private VisitsTrackerInterface $visitTracker;
-    private AppOptions $appOptions;
+    private TrackingOptions $trackingOptions;
     private LoggerInterface $logger;
 
     public function __construct(
         ShortUrlResolverInterface $urlResolver,
         VisitsTrackerInterface $visitTracker,
-        AppOptions $appOptions,
+        TrackingOptions $trackingOptions,
         ?LoggerInterface $logger = null
     ) {
         $this->urlResolver = $urlResolver;
         $this->visitTracker = $visitTracker;
-        $this->appOptions = $appOptions;
+        $this->trackingOptions = $trackingOptions;
         $this->logger = $logger ?? new NullLogger();
     }
 
@@ -48,7 +48,7 @@ abstract class AbstractTrackingAction implements MiddlewareInterface, RequestMet
     {
         $identifier = ShortUrlIdentifier::fromRedirectRequest($request);
         $query = $request->getQueryParams();
-        $disableTrackParam = $this->appOptions->getDisableTrackParam();
+        $disableTrackParam = $this->trackingOptions->getDisableTrackParam();
 
         try {
             $shortUrl = $this->urlResolver->resolveEnabledShortUrl($identifier);

module/Core/src/Action/RedirectAction.php

@@ -21,11 +21,11 @@ class RedirectAction extends AbstractTrackingAction implements StatusCodeInterfa
     public function __construct(
         ShortUrlResolverInterface $urlResolver,
         VisitsTrackerInterface $visitTracker,
-        Options\AppOptions $appOptions,
+        Options\TrackingOptions $trackingOptions,
         RedirectResponseHelperInterface $redirectResponseHelper,
         ?LoggerInterface $logger = null
     ) {
-        parent::__construct($urlResolver, $visitTracker, $appOptions, $logger);
+        parent::__construct($urlResolver, $visitTracker, $trackingOptions, $logger);
         $this->redirectResponseHelper = $redirectResponseHelper;
     }
 

module/Core/src/Config/DeprecatedConfigParser.php

@@ -6,6 +6,7 @@ namespace Shlinkio\Shlink\Core\Config;
 
 use function Functional\compose;
 
+/** @deprecated */
 class DeprecatedConfigParser
 {
     public function __invoke(array $config): array

module/Core/src/Config/SimplifiedConfigParser.php

@@ -19,7 +19,7 @@ use function uksort;
 class SimplifiedConfigParser
 {
     private const SIMPLIFIED_CONFIG_MAPPING = [
-        'disable_track_param' => ['app_options', 'disable_track_param'],
+        'disable_track_param' => ['tracking', 'disable_track_param'],
         'short_domain_schema' => ['url_shortener', 'domain', 'schema'],
         'short_domain_host' => ['url_shortener', 'domain', 'hostname'],
         'validate_url' => ['url_shortener', 'validate_url'],
@@ -38,7 +38,7 @@ class SimplifiedConfigParser
         'mercure_public_hub_url' => ['mercure', 'public_hub_url'],
         'mercure_internal_hub_url' => ['mercure', 'internal_hub_url'],
         'mercure_jwt_secret' => ['mercure', 'jwt_secret'],
-        'anonymize_remote_addr' => ['url_shortener', 'anonymize_remote_addr'],
+        'anonymize_remote_addr' => ['tracking', 'anonymize_remote_addr'],
         'redirect_status_code' => ['url_shortener', 'redirect_status_code'],
         'redirect_cache_lifetime' => ['url_shortener', 'redirect_cache_lifetime'],
         'port' => ['mezzio-swoole', 'swoole-http-server', 'port'],

module/Core/src/Options/AppOptions.php

@@ -12,7 +12,6 @@ class AppOptions extends AbstractOptions
 {
     private string $name = '';
     private string $version = '1.0';
-    private ?string $disableTrackParam = null;
 
     public function getName(): string
     {
@@ -36,16 +35,10 @@ class AppOptions extends AbstractOptions
         return $this;
     }
 
-    /**
-     */
-    public function getDisableTrackParam(): ?string
-    {
-        return $this->disableTrackParam;
-    }
-
+    /** @deprecated  */
     protected function setDisableTrackParam(?string $disableTrackParam): self
     {
-        $this->disableTrackParam = $disableTrackParam;
+        // Keep just for backwards compatibility during hydration
         return $this;
     }
 

module/Core/src/Options/TrackingOptions.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Options;
+
+use Laminas\Stdlib\AbstractOptions;
+
+class TrackingOptions extends AbstractOptions
+{
+    private bool $anonymizeRemoteAddr = true;
+    private bool $trackOrphanVisits = true;
+    private ?string $disableTrackParam = null;
+    private bool $disableTracking = false;
+    private bool $disableIpTracking = false;
+    private bool $disableLocationTracking = false;
+    private bool $disableReferrerTracking = false;
+    private bool $disableUaTracking = false;
+
+    public function anonymizeRemoteAddr(): bool
+    {
+        return $this->anonymizeRemoteAddr;
+    }
+
+    protected function setAnonymizeRemoteAddr(bool $anonymizeRemoteAddr): void
+    {
+        $this->anonymizeRemoteAddr = $anonymizeRemoteAddr;
+    }
+
+    public function trackOrphanVisits(): bool
+    {
+        return $this->trackOrphanVisits;
+    }
+
+    protected function setTrackOrphanVisits(bool $trackOrphanVisits): void
+    {
+        $this->trackOrphanVisits = $trackOrphanVisits;
+    }
+
+    public function getDisableTrackParam(): ?string
+    {
+        return $this->disableTrackParam;
+    }
+
+    protected function setDisableTrackParam(?string $disableTrackParam): void
+    {
+        $this->disableTrackParam = $disableTrackParam;
+    }
+
+    public function disableTracking(): bool
+    {
+        return $this->disableTracking;
+    }
+
+    protected function setDisableTracking(bool $disableTracking): void
+    {
+        $this->disableTracking = $disableTracking;
+    }
+
+    public function disableIpTracking(): bool
+    {
+        return $this->disableIpTracking;
+    }
+
+    protected function setDisableIpTracking(bool $disableIpTracking): void
+    {
+        $this->disableIpTracking = $disableIpTracking;
+    }
+
+    public function disableLocationTracking(): bool
+    {
+        return $this->disableLocationTracking;
+    }
+
+    protected function setDisableLocationTracking(bool $disableLocationTracking): void
+    {
+        $this->disableLocationTracking = $disableLocationTracking;
+    }
+
+    public function disableReferrerTracking(): bool
+    {
+        return $this->disableReferrerTracking;
+    }
+
+    protected function setDisableReferrerTracking(bool $disableReferrerTracking): void
+    {
+        $this->disableReferrerTracking = $disableReferrerTracking;
+    }
+
+    public function disableUaTracking(): bool
+    {
+        return $this->disableUaTracking;
+    }
+
+    protected function setDisableUaTracking(bool $disableUaTracking): void
+    {
+        $this->disableUaTracking = $disableUaTracking;
+    }
+}

module/Core/src/Options/UrlShortenerOptions.php

@@ -19,8 +19,6 @@ class UrlShortenerOptions extends AbstractOptions
     private int $redirectStatusCode = DEFAULT_REDIRECT_STATUS_CODE;
     private int $redirectCacheLifetime = DEFAULT_REDIRECT_CACHE_LIFETIME;
     private bool $autoResolveTitles = false;
-    private bool $anonymizeRemoteAddr = true;
-    private bool $trackOrphanVisits = true;
 
     public function isUrlValidationEnabled(): bool
     {
@@ -69,23 +67,15 @@ class UrlShortenerOptions extends AbstractOptions
         $this->autoResolveTitles = $autoResolveTitles;
     }
 
-    public function anonymizeRemoteAddr(): bool
-    {
-        return $this->anonymizeRemoteAddr;
-    }
-
+    /** @deprecated  */
     protected function setAnonymizeRemoteAddr(bool $anonymizeRemoteAddr): void
     {
-        $this->anonymizeRemoteAddr = $anonymizeRemoteAddr;
-    }
-
-    public function trackOrphanVisits(): bool
-    {
-        return $this->trackOrphanVisits;
+        // Keep just for backwards compatibility during hydration
     }
 
+    /** @deprecated  */
     protected function setTrackOrphanVisits(bool $trackOrphanVisits): void
     {
-        $this->trackOrphanVisits = $trackOrphanVisits;
+        // Keep just for backwards compatibility during hydration
     }
 }

module/Core/src/Visit/VisitsTracker.php

@@ -10,18 +10,18 @@ use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Entity\Visit;
 use Shlinkio\Shlink\Core\EventDispatcher\Event\UrlVisited;
 use Shlinkio\Shlink\Core\Model\Visitor;
-use Shlinkio\Shlink\Core\Options\UrlShortenerOptions;
+use Shlinkio\Shlink\Core\Options\TrackingOptions;
 
 class VisitsTracker implements VisitsTrackerInterface
 {
     private ORM\EntityManagerInterface $em;
     private EventDispatcherInterface $eventDispatcher;
-    private UrlShortenerOptions $options;
+    private TrackingOptions $options;
 
     public function __construct(
         ORM\EntityManagerInterface $em,
         EventDispatcherInterface $eventDispatcher,
-        UrlShortenerOptions $options
+        TrackingOptions $options
     ) {
         $this->em = $em;
         $this->eventDispatcher = $eventDispatcher;