Merge pull request #2570 from shlinkio/develop

Release 5.0.0

Author: acelaya

.github/workflows/ci-db-tests.yml

@@ -13,11 +13,11 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.3', '8.4', '8.5']
+        php-version: ['8.4', '8.5']
     env:
       LC_ALL: C
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Install MSSQL ODBC
         if: ${{ inputs.platform == 'ms' }}
         run: sudo ./data/infra/ci/install-ms-odbc.sh
@@ -35,8 +35,8 @@ jobs:
       - name: Run tests
         run: composer test:db:${{ inputs.platform }}
       - name: Upload code coverage
-        uses: actions/upload-artifact@v4
-        if: ${{ matrix.php-version == '8.3' && inputs.platform == 'sqlite:ci' }}
+        uses: actions/upload-artifact@v5
+        if: ${{ matrix.php-version == '8.4' && inputs.platform == 'sqlite:ci' }}
         with:
           name: coverage-db
           path: |

.github/workflows/ci-tests.yml

@@ -13,11 +13,11 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.3', '8.4', '8.5']
+        php-version: ['8.4', '8.5']
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # rr get-binary picks this env automatically
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Start postgres database server
         if: ${{ inputs.test-group == 'api' }}
         run: docker compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
@@ -32,8 +32,8 @@ jobs:
         if: ${{ inputs.test-group == 'api' }}
         run: ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr
       - run: composer test:${{ inputs.test-group }}:ci
-      - uses: actions/upload-artifact@v4
-        if: ${{ matrix.php-version == '8.3' }}
+      - uses: actions/upload-artifact@v5
+        if: ${{ matrix.php-version == '8.4' }}
         with:
           name: coverage-${{ inputs.test-group }}
           path: |

.github/workflows/ci.yml

@@ -27,10 +27,10 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.3']
+        php-version: ['8.4']
         command: ['cs', 'stan', 'openapi:validate']
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
@@ -69,16 +69,15 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.3']
+        php-version: ['8.4']
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Use PHP
         uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
           extensions-cache-key: tests-extensions-${{ matrix.php-version }}
-      - uses: actions/download-artifact@v4
+      - uses: actions/download-artifact@v6
         with:
           path: build
       - run: mv build/coverage-unit/coverage-unit.cov build/coverage-unit.cov
@@ -87,9 +86,9 @@ jobs:
       - run: mv build/coverage-cli/coverage-cli.cov build/coverage-cli.cov
       - run: vendor/bin/phpcov merge build --clover build/clover.xml
       - name: Publish coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
-          file: ./build/clover.xml
+          files: ./build/clover.xml
 
   delete-artifacts:
     needs:

.github/workflows/publish-openapi-spec.yml

@@ -10,9 +10,9 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.3']
+        php-version: ['8.4']
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Determine version
         id: determine_version
         run: echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT

.github/workflows/publish-release.yml

@@ -10,16 +10,16 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.3', '8.4', '8.5']
+        php-version: ['8.4', '8.4', '8.5']
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
           extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
           install-deps: 'no'
       - run: ./build.sh ${GITHUB_REF#refs/tags/v}
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v5
         with:
           name: dist-files-${{ matrix.php-version }}
           path: build
@@ -28,8 +28,8 @@ jobs:
     needs: ['build']
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/download-artifact@v4
+      - uses: actions/checkout@v5
+      - uses: actions/download-artifact@v6
         with:
           path: build
       - name: Publish release with assets

CHANGELOG.md

@@ -4,6 +4,51 @@ 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).
 
+## [5.0.0] - 2026-01-09
+### Added
+* [#2431](https://github.com/shlinkio/shlink/issues/2431) Add new date-based conditions for the dynamic rules redirections system, that allow to perform redirections based on an ISO-8601 date value.
+
+  * `before-date`: matches when current date and time is earlier than the defined threshold.
+  * `after-date`: matches when current date and time is later than the defined threshold.
+
+* [#2513](https://github.com/shlinkio/shlink/issues/2513) Add support for redis connections via unix socket (e.g. `REDIS_SERVERS=unix:/path/to/redis.sock`).
+* Visits generated in the command line can now be formatted in CSV, via `--format=csv`.
+
+### Changed
+* [#2522](https://github.com/shlinkio/shlink/issues/2522) Shlink no longer tries to detect trusted proxies automatically, when resolving the visitor's IP address, as this is a potential security issue.
+
+    Instead, if you have more than 1 proxy in front of Shlink, you should provide `TRUSTED_PROXIES` env var, with either a comma-separated list of the IP addresses of your proxies, or a number indicating how many proxies are there in front of Shlink.
+
+* [#2311](https://github.com/shlinkio/shlink/issues/2311) All visits-related commands now return more information, and columns are arranged slightly differently.
+
+    Among other things, they now always return the type of the visit, region, visited URL, redirected URL and whether the visit comes from a potential bot or not.
+
+* [#2540](https://github.com/shlinkio/shlink/issues/2540) Update Symfony packages to 8.0.
+* [#2512](https://github.com/shlinkio/shlink/issues/2512) Make all remaining console commands invokable.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* [#2507](https://github.com/shlinkio/shlink/issues/2507) Drop support for PHP 8.3.
+* [#2514](https://github.com/shlinkio/shlink/issues/2514) Remove support to generate QR codes. This functionality is now handled by Shlink Web Client and Shlink Dashboard.
+* [#2517](https://github.com/shlinkio/shlink/issues/2517) Remove `REDIRECT_APPEND_EXTRA_PATH` env var. Use `REDIRECT_EXTRA_PATH_MODE=append` instead.
+* [#2519](https://github.com/shlinkio/shlink/issues/2519) Disabling API keys by their plain-text key is no longer supported. When calling `api-key:disable`, the first argument is now always assumed to be the name.
+* [#2520](https://github.com/shlinkio/shlink/issues/2520) Remove deprecated `--including-all-tags` and `--show-api-key-name` options from `short-url:list` command. Use `--tags-all` and `--show-api-key` instead.
+* [#2521](https://github.com/shlinkio/shlink/issues/2521) Remove deprecated `--tags` option in all commands using it. Use `--tag` multiple times instead, one per tag.
+* [#2543](https://github.com/shlinkio/shlink/issues/2543) Remove support for `--order-by=field,dir` option `short-url:list` command. Use `--order-by=field-dir` instead.
+* Remove support to provide redis database index via URI path. Use `?database=3` query instead.
+* [#2565](https://github.com/shlinkio/shlink/issues/2565) Remove explicit dependency in ext-json, since it's part of PHP since v8.0
+
+### Fixed
+* [#2564](https://github.com/shlinkio/shlink/issues/2564) Fix error when trying to persist non-utf-8 title without being able to determine its original charset for parsing.
+
+  Now, when resolving a website's charset, two improvements have been introduced:
+
+  1. If the `Content-Type` header does not define the charset, we fall back to `<meta charset>` or `<meta http-equiv="Content-Type">`.
+  2. If it's still not possible to determine the charset, we ignore the auto-resolved title, to avoid other encoding errors further down the line.
+
+
 ## [4.6.0] - 2025-11-01
 ### Added
 * [#2327](https://github.com/shlinkio/shlink/issues/2327) Allow filtering short URL lists by those not including certain tags.
@@ -29,6 +74,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
     This is done via the `domain` query parameter in API endpoints, and via the `--domain` option in console commands.
 
 * [#2472](https://github.com/shlinkio/shlink/issues/2472) Add support for PHP 8.5
+* [#2291](https://github.com/shlinkio/shlink/issues/2291) Add `api-key:delete` console command to delete API keys.
 
 ### Changed
 * [#2424](https://github.com/shlinkio/shlink/issues/2424) Make simple console commands invokable.

Dockerfile

@@ -15,13 +15,12 @@ WORKDIR /etc/shlink
 
 # Install required PHP extensions
 RUN \
-    # Temp install dev dependencies needed to compile the extensions
-    # FIXME Deprecated image-related extensions. They can be removed with QR-code support
-    apk add --no-cache --virtual .dev-deps sqlite-dev postgresql-dev icu-dev libzip-dev zlib-dev libpng-dev linux-headers && \
-    docker-php-ext-install -j"$(nproc)" pdo_mysql pdo_pgsql intl calendar sockets bcmath zip gd && \
+    # Temp install dev dependencies needed to compile the extensions \
+    apk add --no-cache --virtual .dev-deps sqlite-dev postgresql-dev icu-dev libzip-dev zlib-dev linux-headers && \
+    docker-php-ext-install -j"$(nproc)" pdo_mysql pdo_pgsql intl calendar sockets bcmath zip && \
     apk add --no-cache sqlite-libs && \
     docker-php-ext-install -j"$(nproc)" pdo_sqlite && \
-    # Remove temp dev extensions, and install prod equivalents that are required at runtime
+    # Remove temp dev extensions, and install prod equivalents that are required at runtime \
     apk del .dev-deps && \
     apk add --no-cache postgresql icu libzip libpng
 

README.md

@@ -36,10 +36,9 @@ 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.3 or 8.4
+* PHP 8.4 or 8.5
 * 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.
     * sockets and bcmath extensions are required if you want to integrate with a RabbitMQ instance.
 * MySQL, MariaDB, PostgreSQL, MicrosoftSQL or SQLite.
     * You will also need the corresponding pdo variation for the database you are planning to use: `pdo_mysql`, `pdo_pgsql`, `pdo_sqlsrv` or `pdo_sqlite`.

UPGRADE.md

@@ -1,5 +1,26 @@
 # Upgrading
 
+## From v4.x to v5.x
+
+### General
+
+* Generating QR codes by appending `/qr-code` to a short URL is no longer possible. Use external services to generate QR codes from a short URL, or the logic embedded in Shlink Web Client and Shlink Dashboard.
+* Shlink no longer tries to detect trusted proxies automatically, when resolving the visitor's IP address.
+    Instead, if you have more than 1 proxy in front of Shlink, you should provide `TRUSTED_PROXIES` env var, with either a comma-separated list of the IP addresses of your proxies, or a number indicating how many proxies are there in front of Shlink.
+* PHP 8.3 is no longer supported. Only 8.4 and 8.5 are officially supported as of Shlink 5.0.0.
+
+### Changes in CLI
+
+* Disabling API keys by their plain-text key is no longer supported. When calling `api-key:disable`, the first argument is now always assumed to be the name.
+* All visits-related commands (`short-url:visits`, `tag:visits`, `domain:visits`, `visit:orphan` and `visit:non-orphan`) now return more information, and columns are arranged slightly differently.
+* The `short-url:list` command no longer accepts `--including-all-tags` and `--show-api-key-name` options. Use `--tags-all` and `--show-api-key` instead.
+* The `short-url:list` command no longer allows ordering using the `--order-by=field,dir` format. Use `--order-by=field-dir` instead.
+* All commands which used to accept the `--tags` flag, no longer accept it. Pass `--tag` multiple times instead, one per tag.
+
+### Changes in env vars
+
+* The `REDIRECT_APPEND_EXTRA_PATH` env var is no longer supported. Use `REDIRECT_EXTRA_PATH_MODE=append` to enable the same behavior.
+
 ## From v3.x to v4.x
 
 ### General

composer.json

@@ -12,19 +12,16 @@
         }
     ],
     "require": {
-        "php": "^8.3",
+        "php": "^8.4",
         "ext-curl": "*",
-        "ext-gd": "*",
-        "ext-json": "*",
         "ext-mbstring": "*",
         "ext-pdo": "*",
         "akrabat/ip-address-middleware": "^2.6",
         "cakephp/chronos": "^3.1",
-        "doctrine/dbal": "^4.3",
+        "doctrine/dbal": "^4.4",
         "doctrine/migrations": "^3.9",
-        "doctrine/orm": "^3.5",
-        "donatj/phpuseragentparser": "^1.10",
-        "endroid/qr-code": "^6.0.5",
+        "doctrine/orm": "^3.6",
+        "donatj/phpuseragentparser": "^1.11",
         "friendsofphp/proxy-manager-lts": "^1.0",
         "geoip2/geoip2": "^3.1",
         "guzzlehttp/guzzle": "^7.9",
@@ -35,6 +32,7 @@
         "laminas/laminas-inputfilter": "^2.31",
         "laminas/laminas-servicemanager": "^3.23",
         "laminas/laminas-stdlib": "^3.20",
+        "league/csv": "^9.28",
         "matomo/matomo-php-tracker": "^3.3",
         "mezzio/mezzio": "^3.20",
         "mezzio/mezzio-fastroute": "^3.12",
@@ -43,22 +41,22 @@
         "pagerfanta/core": "^3.8",
         "ramsey/uuid": "^4.7",
         "shlinkio/doctrine-specification": "^2.2",
-        "shlinkio/shlink-common": "^7.2",
-        "shlinkio/shlink-config": "^4.0",
-        "shlinkio/shlink-event-dispatcher": "^4.3",
-        "shlinkio/shlink-importer": "^5.6",
-        "shlinkio/shlink-installer": "^9.7",
-        "shlinkio/shlink-ip-geolocation": "^4.4",
-        "shlinkio/shlink-json": "^1.2",
+        "shlinkio/shlink-common": "dev-main#d4ae052 as 8.0.0",
+        "shlinkio/shlink-config": "dev-main#fb186e4 as 4.1.0",
+        "shlinkio/shlink-event-dispatcher": "dev-main#54d4701 as 4.4.0",
+        "shlinkio/shlink-importer": "dev-main#63753cf as 5.7.0",
+        "shlinkio/shlink-installer": "dev-develop#a225b16 as 10.0.0",
+        "shlinkio/shlink-ip-geolocation": "dev-main#e0c45b2 as 5.0.0",
+        "shlinkio/shlink-json": "^1.3",
         "spiral/roadrunner": "^2025.1",
         "spiral/roadrunner-cli": "^2.7",
-        "spiral/roadrunner-http": "^3.5",
-        "spiral/roadrunner-jobs": "^4.6",
-        "symfony/console": "^7.3",
-        "symfony/filesystem": "^7.3",
-        "symfony/lock": "^7.3.2",
-        "symfony/process": "^7.3",
-        "symfony/string": "^7.3"
+        "spiral/roadrunner-http": "^3.6",
+        "spiral/roadrunner-jobs": "^4.7",
+        "symfony/console": "^8.0",
+        "symfony/filesystem": "^8.0",
+        "symfony/lock": "^8.0",
+        "symfony/process": "^8.0",
+        "symfony/string": "^8.0"
     },
     "require-dev": {
         "devizzent/cebe-php-openapi": "^1.1.2",
@@ -70,10 +68,9 @@
         "phpunit/php-code-coverage": "^12.0",
         "phpunit/phpcov": "^11.0",
         "phpunit/phpunit": "^12.0.10",
-        "roave/security-advisories": "dev-master",
         "shlinkio/php-coding-standard": "~2.5.0",
-        "shlinkio/shlink-test-utils": "^4.3.1",
-        "symfony/var-dumper": "^7.3",
+        "shlinkio/shlink-test-utils": "^4.4",
+        "symfony/var-dumper": "^8.0",
         "veewee/composer-run-parallel": "^1.4"
     },
     "conflict": {
@@ -147,12 +144,12 @@
         "test:cli:ci": [
             "@putenv GENERATE_COVERAGE=yes",
             "@test:cli",
-            "vendor/bin/phpcov merge build/coverage-cli --php build/coverage-cli.cov && rm build/coverage-cli/*.cov"
+            "@php -d memory_limit=-1 vendor/bin/phpcov merge build/coverage-cli --php build/coverage-cli.cov && rm build/coverage-cli/*.cov"
         ],
         "test:cli:pretty": [
             "@putenv GENERATE_COVERAGE=yes",
             "@test:cli",
-            "phpcov merge build/coverage-cli --html build/coverage-cli/coverage-html && rm build/coverage-cli/*.cov"
+            "@php -d memory_limit=-1 phpcov merge build/coverage-cli --html build/coverage-cli/coverage-html && rm build/coverage-cli/*.cov"
         ],
         "openapi:validate": "php-openapi validate docs/swagger/swagger.json",
         "openapi:inline": "php-openapi inline docs/swagger/swagger.json docs/swagger/openapi-inlined.json",