Merge pull request #2283 from shlinkio/develop

Release 4.3.0

.github/actions/ci-setup/action.yml

@@ -43,5 +43,5 @@ runs:
         coverage: xdebug
     - name: Install dependencies
       if: ${{ inputs.install-deps == 'yes' }}
-      run: composer install --no-interaction --prefer-dist ${{ inputs.php-version == '8.4' && '--ignore-platform-req=php' || '' }}
+      run: composer install --no-interaction --prefer-dist
       shell: bash

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

@@ -14,7 +14,6 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.2', '8.3', '8.4']
-    continue-on-error: ${{ matrix.php-version == '8.4' }}
     env:
       LC_ALL: C
     steps:

.github/workflows/ci-tests.yml

@@ -14,7 +14,6 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.2', '8.3', '8.4']
-    continue-on-error: ${{ matrix.php-version == '8.4' }}
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # rr get-binary picks this env automatically
     steps:

.github/workflows/publish-release.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2', '8.3'] # TODO 8.4
+        php-version: ['8.2', '8.3', '8.4']
     steps:
       - uses: actions/checkout@v4
       - uses: './.github/actions/ci-setup'

CHANGELOG.md

@@ -4,12 +4,58 @@ 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.3.0] - 2024-11-24
+### Added
+* [#2159](https://github.com/shlinkio/shlink/issues/2159) Add support for PHP 8.4.
+* [#2207](https://github.com/shlinkio/shlink/issues/2207) Add `hasRedirectRules` flag to short URL API model. This flag tells if a specific short URL has any redirect rules attached to it.
+* [#1520](https://github.com/shlinkio/shlink/issues/1520) Allow short URLs list to be filtered by `domain`.
+
+    This change applies both to the `GET /short-urls` endpoint, via the `domain` query parameter, and the `short-url:list` console command, via the `--domain`|`-d` flag.
+
+* [#1774](https://github.com/shlinkio/shlink/issues/1774) Add new geolocation redirect rules for the dynamic redirects system.
+
+    * `geolocation-country-code`: Allows to perform redirections based on the ISO 3166-1 alpha-2 two-letter country code resolved while geolocating the visitor.
+    * `geolocation-city-name`: Allows to perform redirections based on the city name resolved while geolocating the visitor.
+
+* [#2032](https://github.com/shlinkio/shlink/issues/2032) Save the URL to which a visitor is redirected when a visit is tracked.
+
+    The value is exposed in the API as a new `redirectUrl` field for visit objects.
+
+    This is useful to know where a visitor was redirected for a short URL with dynamic redirect rules, for special redirects, or simply in case the long URL was changed over time, and you still want to know where visitors were redirected originally.
+
+    Some visits may not have a redirect URL if a redirect didn't happen, like for orphan visits when no special redirects are configured, or when a visit is tracked as part of the pixel action.
+
+### Changed
+* [#2193](https://github.com/shlinkio/shlink/issues/2193) API keys are now hashed using SHA256, instead of being saved in plain text.
+
+    As a side effect, API key names have now become more important, and are considered unique.
+
+    When people update to this Shlink version, existing API keys will be hashed for everything to continue working.
+
+    In order to avoid data to be lost, plain-text keys will be written in the `name` field, either together with any existing name, or as the name itself. Then users are responsible for renaming them using the new `api-key:rename` command.
+
+    For newly created API keys, it is recommended to provide a name, but if not provided, a name will be generated from a redacted version of the new API key.
+
+* Update to Shlink PHP coding standard 2.4
+* Update to `hidehalo/nanoid-php` 2.0
+* Update to PHPStan 2.0
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#2264](https://github.com/shlinkio/shlink/issues/2264) Fix visits counts not being deleted when deleting short URL or orphan visits.
+
+
 ## [4.2.5] - 2024-11-03
 ### Added
 * *Nothing*
 
 ### Changed
-* *Nothing*
+* Update to Shlink PHP coding standard 2.4
 
 ### Deprecated
 * *Nothing*

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.3-alpine3.19 as base
+FROM php:8.3-alpine3.20 AS base
 
 ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}
@@ -7,8 +7,8 @@ ENV SHLINK_RUNTIME ${SHLINK_RUNTIME}
 
 ENV USER_ID '1001'
 ENV PDO_SQLSRV_VERSION 5.12.0
-ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
-ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
+ENV MS_ODBC_DOWNLOAD '7/6/d/76de322a-d860-4894-9945-f0cc5d6a45f8'
+ENV MS_ODBC_SQL_VERSION 18_18.4.1.1
 ENV LC_ALL 'C'
 
 WORKDIR /etc/shlink

README.md

@@ -7,7 +7,7 @@
 [![License](https://img.shields.io/github/license/shlinkio/shlink.svg?style=flat-square)](https://github.com/shlinkio/shlink/blob/main/LICENSE)
 
 [![Mastodon](https://img.shields.io/mastodon/follow/109329425426175098?color=%236364ff&domain=https%3A%2F%2Ffosstodon.org&label=follow&logo=mastodon&logoColor=white&style=flat-square)](https://fosstodon.org/@shlinkio)
-[![Bluesky](https://img.shields.io/badge/follow-shlinkio-0285FF.svg?style=flat-square&logo=bluesky&logoColor=white)](https://bsky.app/profile/shlinkio.bsky.social)
+[![Bluesky](https://img.shields.io/badge/follow-shlinkio-0285FF.svg?style=flat-square&logo=bluesky&logoColor=white)](https://bsky.app/profile/shlink.io)
 [![Paypal donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=aaaaaa)](https://slnk.to/donate)
 
 A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own domain.

composer.json

@@ -18,7 +18,8 @@
         "ext-json": "*",
         "ext-mbstring": "*",
         "ext-pdo": "*",
-        "akrabat/ip-address-middleware": "^2.3",
+        "acelaya/crawler-detect": "^1.3",
+        "acelaya/ip-address-middleware": "^2.4",
         "cakephp/chronos": "^3.1",
         "doctrine/dbal": "^4.2",
         "doctrine/migrations": "^3.8",
@@ -27,9 +28,7 @@
         "friendsofphp/proxy-manager-lts": "^1.0",
         "geoip2/geoip2": "^3.0",
         "guzzlehttp/guzzle": "^7.9",
-        "hidehalo/nanoid-php": "^1.1",
-        "jaybizzle/crawler-detect": "^1.2.116",
-        "laminas/laminas-config": "^3.9",
+        "hidehalo/nanoid-php": "^2.0",
         "laminas/laminas-config-aggregator": "^1.15",
         "laminas/laminas-diactoros": "^3.5",
         "laminas/laminas-inputfilter": "^2.30",
@@ -39,17 +38,17 @@
         "mezzio/mezzio": "^3.20",
         "mezzio/mezzio-fastroute": "^3.12",
         "mezzio/mezzio-problem-details": "^1.15",
-        "mlocati/ip-lib": "^1.18",
-        "mobiledetect/mobiledetectlib": "^4.8",
+        "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/shlink-common": "^6.5",
-        "shlinkio/shlink-config": "^3.3",
+        "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.2",
-        "shlinkio/shlink-ip-geolocation": "^4.1",
+        "shlinkio/shlink-installer": "^9.3",
+        "shlinkio/shlink-ip-geolocation": "^4.2",
         "shlinkio/shlink-json": "^1.1",
         "spiral/roadrunner": "^2024.1",
         "spiral/roadrunner-cli": "^2.6",
@@ -64,16 +63,16 @@
     "require-dev": {
         "devizzent/cebe-php-openapi": "^1.0.1",
         "devster/ubench": "^2.1",
-        "phpstan/phpstan": "^1.12",
-        "phpstan/phpstan-doctrine": "^1.5",
-        "phpstan/phpstan-phpunit": "^1.4",
-        "phpstan/phpstan-symfony": "^1.4",
+        "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",
         "roave/security-advisories": "dev-master",
-        "shlinkio/php-coding-standard": "~2.3.0",
-        "shlinkio/shlink-test-utils": "^4.1.1",
+        "shlinkio/php-coding-standard": "~2.4.0",
+        "shlinkio/shlink-test-utils": "^4.2",
         "symfony/var-dumper": "^7.1",
         "veewee/composer-run-parallel": "^1.4"
     },

config/autoload/ip-address.global.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+use RKA\Middleware\IpAddress;
+use RKA\Middleware\Mezzio\IpAddressFactory;
+
+use const Shlinkio\Shlink\IP_ADDRESS_REQUEST_ATTRIBUTE;
+
+return [
+
+    // Configuration for RKA\Middleware\IpAddress
+    'rka' => [
+        'ip_address' => [
+            'attribute_name' => IP_ADDRESS_REQUEST_ATTRIBUTE,
+            'check_proxy_headers' => true,
+            'trusted_proxies' => [],
+            'headers_to_inspect' => [
+                'CF-Connecting-IP',
+                'X-Forwarded-For',
+                'X-Forwarded',
+                'Forwarded',
+                'True-Client-IP',
+                'X-Real-IP',
+                'X-Cluster-Client-Ip',
+                'Client-Ip',
+            ],
+        ],
+    ],
+
+    'dependencies' => [
+        'factories' => [
+            IpAddress::class => IpAddressFactory::class,
+        ],
+    ],
+
+];

config/autoload/middleware-pipeline.global.php

@@ -11,6 +11,7 @@
 use Shlinkio\Shlink\Common\Middleware\AccessLogMiddleware;
 use Shlinkio\Shlink\Common\Middleware\ContentLengthMiddleware;
 use Shlinkio\Shlink\Common\Middleware\RequestIdMiddleware;
+use Shlinkio\Shlink\Core\Geolocation\Middleware\IpGeolocationMiddleware;
 
 return [
 
@@ -67,8 +68,11 @@
         ],
         'not-found' => [
             'middleware' => [
-                // This middleware is in front of tracking actions explicitly. Putting here for orphan visits tracking
+                // These two middlewares are in front of other tracking actions.
+                // Putting them here for orphan visits tracking
                 IpAddress::class,
+                IpGeolocationMiddleware::class,
+
                 Core\ErrorHandler\NotFoundTypeResolverMiddleware::class,
                 Core\ShortUrl\Middleware\ExtraPathRedirectMiddleware::class,
                 Core\ErrorHandler\NotFoundTrackerMiddleware::class,

config/autoload/routes.config.php

@@ -8,6 +8,7 @@
 use RKA\Middleware\IpAddress;
 use Shlinkio\Shlink\Core\Action as CoreAction;
 use Shlinkio\Shlink\Core\Config\EnvVars;
+use Shlinkio\Shlink\Core\Geolocation\Middleware\IpGeolocationMiddleware;
 use Shlinkio\Shlink\Core\ShortUrl\Middleware\TrimTrailingSlashMiddleware;
 use Shlinkio\Shlink\Rest\Action;
 use Shlinkio\Shlink\Rest\ConfigProvider;
@@ -88,6 +89,7 @@
                 'path' => '/{shortCode}/track',
                 'middleware' => [
                     IpAddress::class,
+                    IpGeolocationMiddleware::class,
                     CoreAction\PixelAction::class,
                 ],
                 'allowed_methods' => [RequestMethodInterface::METHOD_GET],
@@ -105,6 +107,7 @@
                 'path' => sprintf('/{shortCode}%s', $shortUrlRouteSuffix),
                 'middleware' => [
                     IpAddress::class,
+                    IpGeolocationMiddleware::class,
                     TrimTrailingSlashMiddleware::class,
                     CoreAction\RedirectAction::class,
                 ],

config/constants.php

@@ -21,3 +21,5 @@
 const DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS = true;
 const DEFAULT_QR_CODE_COLOR = '#000000'; // Black
 const DEFAULT_QR_CODE_BG_COLOR = '#ffffff'; // White
+const IP_ADDRESS_REQUEST_ATTRIBUTE = 'remote_address';
+const REDIRECT_URL_REQUEST_ATTRIBUTE = 'redirect_url';

data/infra/ci/install-ms-odbc.sh

@@ -3,7 +3,7 @@
 set -ex
 
 curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
-curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
+curl https://packages.microsoft.com/config/ubuntu/24.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
 apt-get update
 ACCEPT_EULA=Y apt-get install msodbcsql18
 # apt-get install unixodbc-dev

data/infra/php.Dockerfile

@@ -1,10 +1,10 @@
-FROM php:8.3-fpm-alpine3.19
+FROM php:8.3-fpm-alpine3.20
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
-ENV APCU_VERSION 5.1.23
+ENV APCU_VERSION 5.1.24
 ENV PDO_SQLSRV_VERSION 5.12.0
-ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
-ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
+ENV MS_ODBC_DOWNLOAD '7/6/d/76de322a-d860-4894-9945-f0cc5d6a45f8'
+ENV MS_ODBC_SQL_VERSION 18_18.4.1.1
 
 RUN apk update
 

data/infra/roadrunner.Dockerfile

@@ -1,10 +1,9 @@
-FROM php:8.3-alpine3.19
+FROM php:8.3-alpine3.20
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
-ENV APCU_VERSION 5.1.23
 ENV PDO_SQLSRV_VERSION 5.12.0
-ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
-ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
+ENV MS_ODBC_DOWNLOAD '7/6/d/76de322a-d860-4894-9945-f0cc5d6a45f8'
+ENV MS_ODBC_SQL_VERSION 18_18.4.1.1
 
 RUN apk update
 
@@ -36,16 +35,6 @@ RUN apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS linux-headers && \
     apk del .phpize-deps
 RUN docker-php-ext-install bcmath
 
-# Install APCu extension
-ADD https://pecl.php.net/get/apcu-$APCU_VERSION.tgz /tmp/apcu.tar.gz
-RUN mkdir -p /usr/src/php/ext/apcu \
-  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1 \
-  && docker-php-ext-configure apcu \
-  && docker-php-ext-install apcu \
-  && rm /tmp/apcu.tar.gz \
-  && rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini \
-  && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
-
 # Install xdebug and sqlsrv driver
 RUN apk add --update linux-headers && \
     wget https://download.microsoft.com/download/${MS_ODBC_DOWNLOAD}/msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \

docs/async-api/async-api.json

@@ -141,6 +141,14 @@
                     "crawlable": {
                         "type": "boolean",
                         "description": "Tells if this URL will be included as 'Allow' in Shlink's robots.txt."
+                    },
+                    "forwardQuery": {
+                        "type": "boolean",
+                        "description": "Tells if this URL will forward the query params to the long URL when visited, as explained in [the docs](https://shlink.io/documentation/some-features/#query-params-forwarding)."
+                    },
+                    "hasRedirectRules": {
+                        "type": "boolean",
+                        "description": "Whether this short URL has redirect rules attached to it or not. Use [this endpoint](https://api-spec.shlink.io/#/Redirect%20rules/listShortUrlRedirectRules) to get the actual list of rules."
                     }
                 },
                 "example": {
@@ -164,7 +172,9 @@
                     },
                     "domain": "example.com",
                     "title": "The title",
-                    "crawlable": false
+                    "crawlable": false,
+                    "forwardQuery": false,
+                    "hasRedirectRules": true
                 }
             },
             "ShortUrlMeta": {
@@ -237,6 +247,11 @@
                         "type": "string",
                         "nullable": true,
                         "description": "The originally visited URL that triggered the tracking of this visit"
+                    },
+                    "redirectUrl": {
+                        "type": "string",
+                        "nullable":  true,
+                        "description": "The URL to which the visitor was redirected, or null if a redirect did not occur, like for 404 requests or pixel tracking"
                     }
                 },
                 "example": {