Add new geolocatio-country-code redirect condition type

composer.json

@@ -49,7 +49,7 @@
         "shlinkio/shlink-event-dispatcher": "^4.1",
         "shlinkio/shlink-importer": "^5.3.2",
         "shlinkio/shlink-installer": "^9.2",
-        "shlinkio/shlink-ip-geolocation": "^4.1",
+        "shlinkio/shlink-ip-geolocation": "dev-main#fadae5d as 4.2",
         "shlinkio/shlink-json": "^1.1",
         "spiral/roadrunner": "^2024.1",
         "spiral/roadrunner-cli": "^2.6",

module/CLI/src/RedirectRule/RedirectRuleHandler.php

@@ -111,6 +111,9 @@ private function addRule(ShortUrl $shortUrl, StyleInterface $io, array $currentR
                 RedirectConditionType::IP_ADDRESS => RedirectCondition::forIpAddress(
                     $this->askMandatory('IP address, CIDR block or wildcard-pattern (1.2.*.*)', $io),
                 ),
+                RedirectConditionType::GEOLOCATION_COUNTRY_CODE => RedirectCondition::forGeolocationCountryCode(
+                    $this->askMandatory('Country code to match?', $io),
+                )
             };
 
             $continue = $io->confirm('Do you want to add another condition?');

module/Core/src/RedirectRule/Entity/RedirectCondition.php

@@ -9,14 +9,15 @@
 use Shlinkio\Shlink\Core\RedirectRule\Model\RedirectConditionType;
 use Shlinkio\Shlink\Core\RedirectRule\Model\Validation\RedirectRulesInputFilter;
 use Shlinkio\Shlink\Core\Util\IpAddressUtils;
+use Shlinkio\Shlink\IpGeolocation\Model\Location;
 
 use function Shlinkio\Shlink\Core\acceptLanguageToLocales;
 use function Shlinkio\Shlink\Core\ArrayUtils\some;
 use function Shlinkio\Shlink\Core\ipAddressFromRequest;
 use function Shlinkio\Shlink\Core\normalizeLocale;
 use function Shlinkio\Shlink\Core\splitLocale;
 use function sprintf;
-use function strtolower;
+use function strcasecmp;
 use function trim;
 
 class RedirectCondition extends AbstractEntity implements JsonSerializable
@@ -52,6 +53,11 @@ public static function forIpAddress(string $ipAddressPattern): self
         return new self(RedirectConditionType::IP_ADDRESS, $ipAddressPattern);
     }
 
+    public static function forGeolocationCountryCode(string $countryCode): self
+    {
+        return new self(RedirectConditionType::GEOLOCATION_COUNTRY_CODE, $countryCode);
+    }
+
     public static function fromRawData(array $rawData): self
     {
         $type = RedirectConditionType::from($rawData[RedirectRulesInputFilter::CONDITION_TYPE]);
@@ -71,6 +77,7 @@ public function matchesRequest(ServerRequestInterface $request): bool
             RedirectConditionType::LANGUAGE => $this->matchesLanguage($request),
             RedirectConditionType::DEVICE => $this->matchesDevice($request),
             RedirectConditionType::IP_ADDRESS => $this->matchesRemoteIpAddress($request),
+            RedirectConditionType::GEOLOCATION_COUNTRY_CODE => $this->matchesGeolocationCountryCode($request),
         };
     }
 
@@ -109,7 +116,7 @@ static function (string $lang) use ($matchLanguage, $matchCountryCode): bool {
     private function matchesDevice(ServerRequestInterface $request): bool
     {
         $device = DeviceType::matchFromUserAgent($request->getHeaderLine('User-Agent'));
-        return $device !== null && $device->value === strtolower($this->matchValue);
+        return $device !== null && $device->value === $this->matchValue;
     }
 
     private function matchesRemoteIpAddress(ServerRequestInterface $request): bool
@@ -118,6 +125,16 @@ private function matchesRemoteIpAddress(ServerRequestInterface $request): bool
         return $remoteAddress !== null && IpAddressUtils::ipAddressMatchesGroups($remoteAddress, [$this->matchValue]);
     }
 
+    private function matchesGeolocationCountryCode(ServerRequestInterface $request): bool
+    {
+        $geolocation = $request->getAttribute(Location::class);
+        if (!($geolocation instanceof Location)) {
+            return false;
+        }
+
+        return strcasecmp($geolocation->countryCode, $this->matchValue) === 0;
+    }
+
     public function jsonSerialize(): array
     {
         return [
@@ -138,6 +155,7 @@ public function toHumanFriendly(): string
                 $this->matchValue,
             ),
             RedirectConditionType::IP_ADDRESS => sprintf('IP address matches %s', $this->matchValue),
+            RedirectConditionType::GEOLOCATION_COUNTRY_CODE => sprintf('country code is %s', $this->matchValue),
         };
     }
 }

module/Core/src/RedirectRule/Model/RedirectConditionType.php

@@ -8,4 +8,5 @@ enum RedirectConditionType: string
     case LANGUAGE = 'language';
     case QUERY_PARAM = 'query-param';
     case IP_ADDRESS = 'ip-address';
+    case GEOLOCATION_COUNTRY_CODE = 'geolocation-country-code';
 }

module/Core/test/RedirectRule/Entity/RedirectConditionTest.php

@@ -3,12 +3,14 @@
 namespace ShlinkioTest\Shlink\Core\RedirectRule\Entity;
 
 use Laminas\Diactoros\ServerRequestFactory;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\TestWith;
 use PHPUnit\Framework\TestCase;
 use Shlinkio\Shlink\Common\Middleware\IpAddressMiddlewareFactory;
 use Shlinkio\Shlink\Core\Model\DeviceType;
 use Shlinkio\Shlink\Core\RedirectRule\Entity\RedirectCondition;
+use Shlinkio\Shlink\IpGeolocation\Model\Location;
 
 use const ShlinkioTest\Shlink\ANDROID_USER_AGENT;
 use const ShlinkioTest\Shlink\DESKTOP_USER_AGENT;
@@ -93,4 +95,20 @@ public function matchesRemoteIpAddress(string|null $remoteIp, string $ipToMatch,
 
         self::assertEquals($expected, $result);
     }
+
+    #[Test, DataProvider('provideVisits')]
+    public function matchesGeolocationCountryCode(Location|null $location, string $countryCodeToMatch, bool $expected): void
+    {
+        $request = ServerRequestFactory::fromGlobals()->withAttribute(Location::class, $location);
+        $result = RedirectCondition::forGeolocationCountryCode($countryCodeToMatch)->matchesRequest($request);
+
+        self::assertEquals($expected, $result);
+    }
+    public static function provideVisits(): iterable
+    {
+        yield 'no location' => [null, 'US', false];
+        yield 'non-matching location' => [new Location(countryCode: 'ES'), 'US', false];
+        yield 'matching location' => [new Location(countryCode: 'US'), 'US', true];
+        yield 'matching case-insensitive' => [new Location(countryCode: 'US'), 'us', true];
+    }
 }