Merge pull request #2317 from shlinkio/develop

Release 4.4.0
shlinkio · Dec 27, 2024 · 0a67f71 · 0a67f71
2 parents 8d4f2bb + 11fa28e
commit 0a67f71
Show file tree

Hide file tree

Showing 166 changed files with 1,469 additions and 1,042 deletions.
diff --git a/.github/workflows/ci-db-tests.yml b/.github/workflows/ci-db-tests.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2', '8.3', '8.4']
+        php-version: ['8.3', '8.4']
     env:
       LC_ALL: C
     steps:

diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2', '8.3', '8.4']
+        php-version: ['8.3', '8.4']
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # rr get-binary picks this env automatically
     steps:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -28,7 +28,7 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.3']
-        command: ['cs', 'stan', 'swagger:validate']
+        command: ['cs', 'stan', 'openapi:validate']
     steps:
       - uses: actions/checkout@v4
       - uses: './.github/actions/ci-setup'

diff --git a/.github/workflows/publish-swagger-spec.yml → .github/workflows/publish-openapi-spec.yml b/.github/workflows/publish-swagger-spec.yml → .github/workflows/publish-openapi-spec.yml
@@ -1,4 +1,4 @@
-name: Publish swagger spec
+name: Publish openapi spec
 
 on:
   push:
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2']
+        php-version: ['8.3']
     steps:
       - uses: actions/checkout@v4
       - name: Determine version
@@ -20,10 +20,10 @@ jobs:
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
-      - run: composer swagger:inline
+          extensions-cache-key: publish-openapi-spec-extensions-${{ matrix.php-version }}
+      - run: composer openapi:inline
       - run: mkdir ${{ steps.determine_version.outputs.version }}
-      - run: mv docs/swagger/swagger-inlined.json ${{ steps.determine_version.outputs.version }}/open-api-spec.json
+      - run: mv docs/swagger/openapi-inlined.json ${{ steps.determine_version.outputs.version }}/open-api-spec.json
       - name: Publish spec
         uses: JamesIves/github-pages-deploy-action@v4
         with:

diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2', '8.3', '8.4']
+        php-version: ['8.3', '8.4']
     steps:
       - uses: actions/checkout@v4
       - uses: './.github/actions/ci-setup'

diff --git a/.gitignore b/.gitignore
@@ -10,7 +10,6 @@ data/database.sqlite
 data/shlink-tests.db
 data/GeoLite2-City.*
 data/infra/matomo
-docs/swagger-ui*
 docs/mercure.html
 .phpunit.result.cache
-docs/swagger/swagger-inlined.json
+docs/swagger/openapi-inlined.json
diff --git a/CHANGELOG.md b/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).
 
+# [4.4.0] - 2024-12-27
+### Added
+* [#2265](https://github.com/shlinkio/shlink/issues/2265) Add a new `REDIRECT_EXTRA_PATH_MODE` option that accepts three values:
+
+    * `default`: Short URLs only match if the path matches their short code or custom slug.
+    * `append`: Short URLs are matched as soon as the path starts with the short code or custom slug, and the extra path is appended to the long URL before redirecting.
+    * `ignore`: Short URLs are matched as soon as the path starts with the short code or custom slug, and the extra path is ignored.
+
+    This option effectively replaces the old `REDIRECT_APPEND_EXTRA_PATH` option, which is now deprecated and will be removed in Shlink 5.0.0
+
+* [#2156](https://github.com/shlinkio/shlink/issues/2156) Be less restrictive on what characters are disallowed in custom slugs.
+
+    All [URI-reserved characters](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2) were disallowed up until now, but from now on, only the gen-delimiters are.
+
+* [#2229](https://github.com/shlinkio/shlink/issues/2229) Add `logo=disabled` query param to dynamically disable the default logo on QR codes.
+* [#2206](https://github.com/shlinkio/shlink/issues/2206) Add new `DB_USE_ENCRYPTION` config option to enable SSL database connections trusting any server certificate.
+* [#2209](https://github.com/shlinkio/shlink/issues/2209) Redirect rules are now imported when importing short URLs from a Shlink >=4.0 instance.
+
+### Changed
+* [#2281](https://github.com/shlinkio/shlink/issues/2281) Update docker image to PHP 8.4
+* [#2124](https://github.com/shlinkio/shlink/issues/2124) Improve how Shlink decides if a GeoLite db file needs to be downloaded, and reduces the chances for API limits to be reached.
+
+    Now Shlink tracks all download attempts, and knows which of them failed and succeeded. This lets it know when was the last error or success, how many consecutive errors have happened, etc.
+
+    It also tracks now the reason for a download to be attempted, and the error that happened when one fails.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* [#2247](https://github.com/shlinkio/shlink/issues/2247) Drop support for PHP 8.2
+
+### Fixed
+* *Nothing*
+
+
 # [4.3.1] - 2024-11-25
 ### Added
 * *Nothing*

diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM php:8.3-alpine3.20 AS base
+FROM php:8.4-alpine3.21 AS base
 
 ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}
@@ -36,7 +36,7 @@ RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
     apk del .phpize-deps
 
 # Install shlink
-FROM base as builder
+FROM base AS builder
 COPY . .
 COPY --from=composer:2 /usr/bin/composer ./composer.phar
 RUN apk add --no-cache git && \

diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ The idea is that you can just generate a container using the image and provide t
 
 First, make sure the host where you are going to run shlink fulfills these requirements:
 
-* PHP 8.2 or 8.3
+* PHP 8.3 or 8.4
 * The next PHP extensions: json, curl, pdo, intl, gd and gmp/bcmath.
     * apcu extension is recommended if you don't plan to use RoadRunner.
     * xml extension is required if you want to generate QR codes in svg format.

diff --git a/composer.json b/composer.json
@@ -12,68 +12,68 @@
         }
     ],
     "require": {
-        "php": "^8.2",
+        "php": "^8.3",
         "ext-curl": "*",
         "ext-gd": "*",
         "ext-json": "*",
         "ext-mbstring": "*",
         "ext-pdo": "*",
-        "akrabat/ip-address-middleware": "^2.4",
+        "akrabat/ip-address-middleware": "^2.5",
         "cakephp/chronos": "^3.1",
         "doctrine/dbal": "^4.2",
         "doctrine/migrations": "^3.8",
         "doctrine/orm": "^3.3",
+        "donatj/phpuseragentparser": "^1.10",
         "endroid/qr-code": "^6.0",
         "friendsofphp/proxy-manager-lts": "^1.0",
-        "geoip2/geoip2": "^3.0",
+        "geoip2/geoip2": "^3.1",
         "guzzlehttp/guzzle": "^7.9",
         "hidehalo/nanoid-php": "^2.0",
         "jaybizzle/crawler-detect": "^1.3",
-        "laminas/laminas-config-aggregator": "^1.15",
+        "laminas/laminas-config-aggregator": "^1.17",
         "laminas/laminas-diactoros": "^3.5",
-        "laminas/laminas-inputfilter": "^2.30",
-        "laminas/laminas-servicemanager": "^3.22",
-        "laminas/laminas-stdlib": "^3.19",
+        "laminas/laminas-inputfilter": "^2.31",
+        "laminas/laminas-servicemanager": "^3.23",
+        "laminas/laminas-stdlib": "^3.20",
         "matomo/matomo-php-tracker": "^3.3",
         "mezzio/mezzio": "^3.20",
         "mezzio/mezzio-fastroute": "^3.12",
         "mezzio/mezzio-problem-details": "^1.15",
         "mlocati/ip-lib": "^1.18.1",
-        "mobiledetect/mobiledetectlib": "4.8.x-dev#920c549 as 4.9",
         "pagerfanta/core": "^3.8",
         "ramsey/uuid": "^4.7",
-        "shlinkio/doctrine-specification": "^2.1.1",
+        "shlinkio/doctrine-specification": "^2.2",
         "shlinkio/shlink-common": "^6.6",
         "shlinkio/shlink-config": "^3.4",
         "shlinkio/shlink-event-dispatcher": "^4.1",
-        "shlinkio/shlink-importer": "^5.3.2",
-        "shlinkio/shlink-installer": "^9.3",
+        "shlinkio/shlink-importer": "^5.5",
+        "shlinkio/shlink-installer": "^9.4",
         "shlinkio/shlink-ip-geolocation": "^4.2",
-        "shlinkio/shlink-json": "^1.1",
-        "spiral/roadrunner": "^2024.1",
+        "shlinkio/shlink-json": "^1.2",
+        "spiral/roadrunner": "^2024.3",
         "spiral/roadrunner-cli": "^2.6",
         "spiral/roadrunner-http": "^3.5",
-        "spiral/roadrunner-jobs": "^4.5",
-        "symfony/console": "^7.1",
-        "symfony/filesystem": "^7.1",
-        "symfony/lock": "^7.1",
-        "symfony/process": "^7.1",
-        "symfony/string": "^7.1"
+        "spiral/roadrunner-jobs": "^4.6",
+        "symfony/console": "^7.2",
+        "symfony/filesystem": "^7.2",
+        "symfony/lock": "^7.2",
+        "symfony/process": "^7.2",
+        "symfony/string": "^7.2"
     },
     "require-dev": {
-        "devizzent/cebe-php-openapi": "^1.0.1",
+        "devizzent/cebe-php-openapi": "^1.1.2",
         "devster/ubench": "^2.1",
         "phpstan/phpstan": "^2.0",
         "phpstan/phpstan-doctrine": "^2.0",
         "phpstan/phpstan-phpunit": "^2.0",
         "phpstan/phpstan-symfony": "^2.0",
         "phpunit/php-code-coverage": "^11.0",
         "phpunit/phpcov": "^10.0",
-        "phpunit/phpunit": "^11.4",
+        "phpunit/phpunit": "^11.5",
         "roave/security-advisories": "dev-master",
         "shlinkio/php-coding-standard": "~2.4.0",
         "shlinkio/shlink-test-utils": "^4.2",
-        "symfony/var-dumper": "^7.1",
+        "symfony/var-dumper": "^7.2",
         "veewee/composer-run-parallel": "^1.4"
     },
     "conflict": {
@@ -108,7 +108,7 @@
     },
     "scripts": {
         "ci": [
-            "@parallel cs stan swagger:validate test:unit:ci test:db:sqlite:ci test:db:postgres test:db:mysql test:db:maria test:db:ms",
+            "@parallel cs stan openapi:validate test:unit:ci test:db:sqlite:ci test:db:postgres test:db:mysql test:db:maria test:db:ms",
             "@parallel test:api:ci test:cli:ci"
         ],
         "cs": "phpcs -s",
@@ -154,36 +154,18 @@
             "@test:cli",
             "phpcov merge build/coverage-cli --html build/coverage-cli/coverage-html && rm build/coverage-cli/*.cov"
         ],
-        "swagger:validate": "php-openapi validate docs/swagger/swagger.json",
-        "swagger:inline": "php-openapi inline docs/swagger/swagger.json docs/swagger/swagger-inlined.json",
+        "openapi:validate": "@php -d error_reporting=\"E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED\" vendor/bin/php-openapi validate docs/swagger/swagger.json",
+        "openapi:inline": "@php -d error_reporting=\"E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED\" vendor/bin/php-openapi inline docs/swagger/swagger.json docs/swagger/openapi-inlined.json",
+        "swagger:validate": [
+            "echo \"This command is deprecated. Use openapi:validate instead\"",
+            "@openapi:validate"
+        ],
+        "swagger:inline": [
+            "echo \"This command is deprecated. Use openapi:inline instead\"",
+            "@openapi:inline"
+        ],
         "clean:dev": "rm -f data/database.sqlite && rm -f config/params/generated_config.php"
     },
-    "scripts-descriptions": {
-        "ci": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"swagger:validate\" and \"test:ci\"</>",
-        "cs": "<fg=blue;options=bold>Checks coding styles</>",
-        "cs:fix": "<fg=blue;options=bold>Fixes coding styles, when possible</>",
-        "stan": "<fg=blue;options=bold>Inspects code with phpstan</>",
-        "test": "<fg=blue;options=bold>Runs all test suites</>",
-        "test:unit": "<fg=blue;options=bold>Runs unit test suites</>",
-        "test:unit:ci": "<fg=blue;options=bold>Runs unit test suites, generating all needed reports and logs for CI envs</>",
-        "test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
-        "test:db": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL, MariaDB, PostgreSQL and MsSQL</>",
-        "test:db:sqlite": "<fg=blue;options=bold>Runs database test suites on a SQLite database</>",
-        "test:db:sqlite:ci": "<fg=blue;options=bold>Runs database test suites on a SQLite database, generating all needed reports and logs for CI envs</>",
-        "test:db:mysql": "<fg=blue;options=bold>Runs database test suites on a MySQL database</>",
-        "test:db:maria": "<fg=blue;options=bold>Runs database test suites on a MariaDB database</>",
-        "test:db:postgres": "<fg=blue;options=bold>Runs database test suites on a PostgreSQL database</>",
-        "test:db:ms": "<fg=blue;options=bold>Runs database test suites on a Microsoft SQL Server database</>",
-        "test:api": "<fg=blue;options=bold>Runs API test suites</>",
-        "test:api:ci": "<fg=blue;options=bold>Runs API test suites, and generates code coverage for CI</>",
-        "test:api:pretty": "<fg=blue;options=bold>Runs API test suites, and generates code coverage in HTML format</>",
-        "test:cli": "<fg=blue;options=bold>Runs CLI test suites</>",
-        "test:cli:ci": "<fg=blue;options=bold>Runs CLI test suites, and generates code coverage for CI</>",
-        "test:cli:pretty": "<fg=blue;options=bold>Runs CLI test suites, and generates code coverage in HTML format</>",
-        "swagger:validate": "<fg=blue;options=bold>Validates the swagger docs, making sure they fulfil the spec</>",
-        "swagger:inline": "<fg=blue;options=bold>Inlines swagger docs in a single file</>",
-        "clean:dev": "<fg=blue;options=bold>Deletes artifacts which are gitignored and could affect dev env</>"
-    },
     "config": {
         "sort-packages": true,
         "platform-check": false,

diff --git a/config/autoload/entity-manager.global.php b/config/autoload/entity-manager.global.php
@@ -12,9 +12,10 @@
 
 return (static function (): array {
     $driver = EnvVars::DB_DRIVER->loadFromEnv();
+    $useEncryption = (bool) EnvVars::DB_USE_ENCRYPTION->loadFromEnv();
     $isMysqlCompatible = contains($driver, ['maria', 'mysql']);
 
-    $resolveDriver = static fn () => match ($driver) {
+    $doctrineDriver = match ($driver) {
         'postgres' => 'pdo_pgsql',
         'mssql' => 'pdo_sqlsrv',
         default => 'pdo_mysql',
@@ -23,31 +24,40 @@
         $value = $envVar->loadFromEnv();
         return $value === null ? null : (string) $value;
     };
-    $resolveCharset = static fn () => match ($driver) {
+    $charset = match ($driver) {
         // This does not determine charsets or collations in tables or columns, but the charset used in the data
         // flowing in the connection, so it has to match what has been set in the database.
         'maria', 'mysql' => 'utf8mb4',
         'postgres' => 'utf8',
         default => null,
     };
-
-    $resolveConnection = static fn () => match ($driver) {
+    $driverOptions = match ($driver) {
+        'mssql' => ['TrustServerCertificate' => 'true'],
+        'maria', 'mysql' => ! $useEncryption ? [] : [
+            1007 => true, // PDO::MYSQL_ATTR_SSL_KEY: Require using SSL
+            1014 => false, // PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT: Trust any certificate
+        ],
+        'postgres' =>  ! $useEncryption ? [] : [
+            'sslmode' => 'require', // Require connections to be encrypted
+            'sslrootcert' => '', // Allow any certificate
+        ],
+        default => [],
+    };
+    $connection = match ($driver) {
         null, 'sqlite' => [
             'driver' => 'pdo_sqlite',
             'path' => 'data/database.sqlite',
         ],
         default => [
-            'driver' => $resolveDriver(),
+            'driver' => $doctrineDriver,
             'dbname' => EnvVars::DB_NAME->loadFromEnv(),
             'user' => $readCredentialAsString(EnvVars::DB_USER),
             'password' => $readCredentialAsString(EnvVars::DB_PASSWORD),
             'host' => EnvVars::DB_HOST->loadFromEnv(),
             'port' => EnvVars::DB_PORT->loadFromEnv(),
             'unix_socket' => $isMysqlCompatible ? EnvVars::DB_UNIX_SOCKET->loadFromEnv() : null,
-            'charset' => $resolveCharset(),
-            'driverOptions' => $driver !== 'mssql' ? [] : [
-                'TrustServerCertificate' => 'true',
-            ],
+            'charset' => $charset,
+            'driverOptions' => $driverOptions,
         ],
     };
 
@@ -63,7 +73,7 @@
                     Events::postFlush => [ShortUrlVisitsCountTracker::class, OrphanVisitsCountTracker::class],
                 ],
             ],
-            'connection' => $resolveConnection(),
+            'connection' => $connection,
         ],
 
     ];

diff --git a/config/autoload/installer.global.php b/config/autoload/installer.global.php
@@ -20,6 +20,7 @@
             Option\Database\DatabaseUserConfigOption::class,
             Option\Database\DatabasePasswordConfigOption::class,
             Option\Database\DatabaseUnixSocketConfigOption::class,
+            Option\Database\DatabaseUseEncryptionConfigOption::class,
             Option\UrlShortener\ShortDomainHostConfigOption::class,
             Option\UrlShortener\ShortDomainSchemaConfigOption::class,
             Option\Redirect\BaseUrlRedirectConfigOption::class,
@@ -41,7 +42,7 @@
             Option\UrlShortener\RedirectStatusCodeConfigOption::class,
             Option\UrlShortener\RedirectCacheLifeTimeConfigOption::class,
             Option\UrlShortener\AutoResolveTitlesConfigOption::class,
-            Option\UrlShortener\AppendExtraPathConfigOption::class,
+            Option\UrlShortener\ExtraPathModeConfigOption::class,
             Option\UrlShortener\EnableMultiSegmentSlugsConfigOption::class,
             Option\UrlShortener\EnableTrailingSlashConfigOption::class,
             Option\UrlShortener\ShortUrlModeConfigOption::class,

diff --git a/data/infra/php.Dockerfile b/data/infra/php.Dockerfile
@@ -1,4 +1,4 @@
-FROM php:8.3-fpm-alpine3.20
+FROM php:8.4-fpm-alpine3.21
 MAINTAINER Alejandro Celaya <[email protected]>
 
 ENV APCU_VERSION 5.1.24

diff --git a/data/infra/roadrunner.Dockerfile b/data/infra/roadrunner.Dockerfile
@@ -1,4 +1,4 @@
-FROM php:8.3-alpine3.20
+FROM php:8.4-alpine3.21
 MAINTAINER Alejandro Celaya <[email protected]>
 
 ENV PDO_SQLSRV_VERSION 5.12.0