Merge pull request #1384 from acelaya-forks/feature/default-domain-role

Feature/default domain role

CHANGELOG.md

@@ -4,6 +4,42 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [3.0.3] - 2022-02-19
+### Added
+* *Nothing*
+
+### Changed
+* [#1382](https://github.com/shlinkio/shlink/issues/1382) Updated docker image to PHP 8.1.3.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1377](https://github.com/shlinkio/shlink/issues/1377) Fixed installer always setting delete threshold with value 1.
+* [#1379](https://github.com/shlinkio/shlink/issues/1379) Ensured API keys cannot be created with a domain-only role linked to default domain.
+
+
+## [3.0.2] - 2022-02-10
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1373](https://github.com/shlinkio/shlink/issues/1373) Fixed incorrect config import when updating from Shlink 2.x using SQLite.
+* [#1369](https://github.com/shlinkio/shlink/issues/1369) Fixed slow regexps in `.htaccess` file.
+
+
 ## [3.0.1] - 2022-02-04
 ### Added
 * *Nothing*

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.1.1-alpine3.15 as base
+FROM php:8.1.3-alpine3.15 as base
 
 ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}

composer.json

@@ -51,7 +51,7 @@
         "shlinkio/shlink-config": "^1.6",
         "shlinkio/shlink-event-dispatcher": "^2.3",
         "shlinkio/shlink-importer": "^2.5",
-        "shlinkio/shlink-installer": "^7.0",
+        "shlinkio/shlink-installer": "^7.0.2",
         "shlinkio/shlink-ip-geolocation": "^2.2",
         "symfony/console": "^6.0",
         "symfony/filesystem": "^6.0",

data/infra/php.Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.1.1-fpm-alpine3.15
+FROM php:8.1.3-fpm-alpine3.15
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
 ENV APCU_VERSION 5.1.21

data/infra/swoole.Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.1.1-alpine3.15
+FROM php:8.1.3-alpine3.15
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
 ENV APCU_VERSION 5.1.21

module/CLI/config/dependencies.config.php

@@ -72,7 +72,7 @@ return [
             TrackingOptions::class,
         ],
         Util\ProcessRunner::class => [SymfonyCli\Helper\ProcessHelper::class],
-        ApiKey\RoleResolver::class => [DomainService::class],
+        ApiKey\RoleResolver::class => [DomainService::class, 'config.url_shortener.domain.hostname'],
 
         Command\ShortUrl\CreateShortUrlCommand::class => [
             Service\UrlShortener::class,

module/CLI/src/ApiKey/RoleResolver.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\ApiKey;
 
+use Shlinkio\Shlink\CLI\Exception\InvalidRoleConfigException;
 use Shlinkio\Shlink\Core\Domain\DomainServiceInterface;
 use Shlinkio\Shlink\Rest\ApiKey\Model\RoleDefinition;
 use Symfony\Component\Console\Input\InputInterface;
@@ -12,24 +13,33 @@ use function is_string;
 
 class RoleResolver implements RoleResolverInterface
 {
-    public function __construct(private DomainServiceInterface $domainService)
+    public function __construct(private DomainServiceInterface $domainService, private string $defaultDomain)
     {
     }
 
     public function determineRoles(InputInterface $input): array
     {
-        $domainAuthority = $input->getOption('domain-only');
-        $author = $input->getOption('author-only');
+        $domainAuthority = $input->getOption(self::DOMAIN_ONLY_PARAM);
+        $author = $input->getOption(self::AUTHOR_ONLY_PARAM);
 
         $roleDefinitions = [];
         if ($author) {
             $roleDefinitions[] = RoleDefinition::forAuthoredShortUrls();
         }
         if (is_string($domainAuthority)) {
-            $domain = $this->domainService->getOrCreate($domainAuthority);
-            $roleDefinitions[] = RoleDefinition::forDomain($domain);
+            $roleDefinitions[] = $this->resolveRoleForAuthority($domainAuthority);
         }
 
         return $roleDefinitions;
     }
+
+    private function resolveRoleForAuthority(string $domainAuthority): RoleDefinition
+    {
+        if ($domainAuthority === $this->defaultDomain) {
+            throw InvalidRoleConfigException::forDomainOnlyWithDefaultDomain();
+        }
+
+        $domain = $this->domainService->getOrCreate($domainAuthority);
+        return RoleDefinition::forDomain($domain);
+    }
 }

module/CLI/src/Exception/InvalidRoleConfigException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Exception;
+
+use InvalidArgumentException;
+use Shlinkio\Shlink\Rest\ApiKey\Role;
+
+use function sprintf;
+
+class InvalidRoleConfigException extends InvalidArgumentException implements ExceptionInterface
+{
+    public static function forDomainOnlyWithDefaultDomain(): self
+    {
+        return new self(sprintf(
+            'You cannot create an API key with the "%s" role attached to the default domain. '
+            . 'The role is currently limited to non-default domains.',
+            Role::DOMAIN_SPECIFIC,
+        ));
+    }
+}

module/CLI/test/ApiKey/RoleResolverTest.php

@@ -8,6 +8,7 @@ use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Shlinkio\Shlink\CLI\ApiKey\RoleResolver;
+use Shlinkio\Shlink\CLI\Exception\InvalidRoleConfigException;
 use Shlinkio\Shlink\Core\Domain\DomainServiceInterface;
 use Shlinkio\Shlink\Core\Entity\Domain;
 use Shlinkio\Shlink\Rest\ApiKey\Model\RoleDefinition;
@@ -23,7 +24,7 @@ class RoleResolverTest extends TestCase
     protected function setUp(): void
     {
         $this->domainService = $this->prophesize(DomainServiceInterface::class);
-        $this->resolver = new RoleResolver($this->domainService->reveal());
+        $this->resolver = new RoleResolver($this->domainService->reveal(), 'default.com');
     }
 
     /**
@@ -94,4 +95,16 @@ class RoleResolverTest extends TestCase
             1,
         ];
     }
+
+    /** @test */
+    public function exceptionIsThrownWhenTryingToAddDomainOnlyLinkedToDefaultDomain(): void
+    {
+        $input = $this->prophesize(InputInterface::class);
+        $input->getOption(RoleResolver::DOMAIN_ONLY_PARAM)->willReturn('default.com');
+        $input->getOption(RoleResolver::AUTHOR_ONLY_PARAM)->willReturn(null);
+
+        $this->expectException(InvalidRoleConfigException::class);
+
+        $this->resolver->determineRoles($input->reveal());
+    }
 }

module/CLI/test/Exception/InvalidRoleConfigExceptionTest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\CLI\Exception;
+
+use PHPUnit\Framework\TestCase;
+use Shlinkio\Shlink\CLI\Exception\InvalidRoleConfigException;
+use Shlinkio\Shlink\Rest\ApiKey\Role;
+
+use function sprintf;
+
+class InvalidRoleConfigExceptionTest extends TestCase
+{
+    /** @test */
+    public function forDomainOnlyWithDefaultDomainGeneratesExpectedException(): void
+    {
+        $e = InvalidRoleConfigException::forDomainOnlyWithDefaultDomain();
+
+        self::assertEquals(sprintf(
+            'You cannot create an API key with the "%s" role attached to the default domain. '
+            . 'The role is currently limited to non-default domains.',
+            Role::DOMAIN_SPECIFIC,
+        ), $e->getMessage());
+    }
+}

public/.htaccess

@@ -4,7 +4,7 @@ RewriteEngine On
 RewriteCond %{REQUEST_FILENAME} -f [OR]
 RewriteCond %{REQUEST_FILENAME} -l [OR]
 RewriteCond %{REQUEST_FILENAME} -d
-RewriteRule ^.*$ - [NC,L]
+RewriteRule ^ - [NC,L]
 
 # The following rewrites all other queries to index.php. The
 # condition ensures that if you are using Apache aliases to do
@@ -12,6 +12,6 @@ RewriteRule ^.*$ - [NC,L]
 # allow proper resolution of the index.php file; it will work
 # in non-aliased environments as well, providing a safe, one-size
 # fits all solution.
-RewriteCond %{REQUEST_URI}::$1 ^(/.+)(.+)::\2$
-RewriteRule ^(.*) - [E=BASE:%1]
-RewriteRule ^(.*)$ %{ENV:BASE}index.php [NC,L]
+RewriteCond $0::%{REQUEST_URI} ^([^:]*+(?::[^:]*+)*?)::(/.+?)\1$
+RewriteRule .+ - [E=BASE:%2]
+RewriteRule .* %{ENV:BASE}index.php [NC,L]