Merge pull request #1215 from shlinkio/develop

Release 2.9.2

.dockerignore

@@ -5,7 +5,7 @@ data/log/*
 data/locks/*
 data/proxies/*
 data/migrations_template.txt
-data/GeoLite2-City.*
+data/GeoLite2-City*
 data/database.sqlite
 data/shlink-tests.db
 CHANGELOG.md

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4']
+        php-version: ['8.0']
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -21,7 +21,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: none
       - run: composer install --no-interaction --prefer-dist
       - run: composer cs
@@ -30,7 +30,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4']
+        php-version: ['8.0']
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -39,7 +39,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: none
       - run: composer install --no-interaction --prefer-dist
       - run: composer stan
@@ -48,7 +48,8 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0', '8.1']
+    continue-on-error: ${{ matrix.php-version == '8.1' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -57,13 +58,16 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: pcov
           ini-values: pcov.directory=module
-      - run: composer install --no-interaction --prefer-dist
+      - if: ${{ matrix.php-version == '8.1' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.1' }}
+        run: composer install --no-interaction --prefer-dist
       - run: composer test:unit:ci
       - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '7.4' }}
+        if: ${{ matrix.php-version == '8.0' }}
         with:
           name: coverage-unit
           path: |
@@ -74,7 +78,8 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0', '8.1']
+    continue-on-error: ${{ matrix.php-version == '8.1' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -83,13 +88,16 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: pcov
           ini-values: pcov.directory=module
-      - run: composer install --no-interaction --prefer-dist
+      - if: ${{ matrix.php-version == '8.1' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.1' }}
+        run: composer install --no-interaction --prefer-dist
       - run: composer test:db:sqlite:ci
       - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '7.4' }}
+        if: ${{ matrix.php-version == '8.0' }}
         with:
           name: coverage-db
           path: |
@@ -100,7 +108,8 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0', '8.1']
+    continue-on-error: ${{ matrix.php-version == '8.1' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -111,16 +120,20 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: none
-      - run: composer install --no-interaction --prefer-dist
+      - if: ${{ matrix.php-version == '8.1' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.1' }}
+        run: composer install --no-interaction --prefer-dist
       - run: composer test:db:mysql
 
   db-tests-maria:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0', '8.1']
+    continue-on-error: ${{ matrix.php-version == '8.1' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -131,16 +144,20 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: none
-      - run: composer install --no-interaction --prefer-dist
+      - if: ${{ matrix.php-version == '8.1' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.1' }}
+        run: composer install --no-interaction --prefer-dist
       - run: composer test:db:maria
 
   db-tests-postgres:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0', '8.1']
+    continue-on-error: ${{ matrix.php-version == '8.1' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -151,16 +168,20 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: none
-      - run: composer install --no-interaction --prefer-dist
+      - if: ${{ matrix.php-version == '8.1' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.1' }}
+        run: composer install --no-interaction --prefer-dist
       - run: composer test:db:postgres
 
   db-tests-ms:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0', '8.1']
+    continue-on-error: ${{ matrix.php-version == '8.1' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -169,13 +190,25 @@ jobs:
       - name: Start database server
         run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_ms
       - name: Use PHP
+        if: ${{ matrix.php-version == '8.1' }}
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3, pdo_sqlsrv-5.9.0
+          extensions: swoole-4.7.1, pdo_sqlsrv-5.10.0beta1
           coverage: none
-      - run: composer install --no-interaction --prefer-dist
+      - name: Use PHP
+        if: ${{ matrix.php-version != '8.1' }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.7.1, pdo_sqlsrv-5.9.0
+          coverage: none
+      - if: ${{ matrix.php-version == '8.1' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.1' }}
+        run: composer install --no-interaction --prefer-dist
       - name: Create test database
         run: docker-compose exec -T shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
       - run: composer test:db:ms
@@ -184,7 +217,8 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0', '8.1']
+    continue-on-error: ${{ matrix.php-version == '8.1' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -195,13 +229,16 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: pcov
           ini-values: pcov.directory=module
-      - run: composer install --no-interaction --prefer-dist
+      - if: ${{ matrix.php-version == '8.1' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.1' }}
+        run: composer install --no-interaction --prefer-dist
       - run: bin/test/run-api-tests.sh
       - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '7.4' }}
+        if: ${{ matrix.php-version == '8.0' }}
         with:
           name: coverage-api
           path: |
@@ -216,7 +253,9 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0', '8.1']
+        test-group: ['unit', 'db']
+    continue-on-error: ${{ matrix.php-version == '8.1' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -225,14 +264,17 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.7.1
           coverage: pcov
           ini-values: pcov.directory=module
-      - run: composer install --no-interaction --prefer-dist
+      - if: ${{ matrix.php-version == '8.1' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.1' }}
+        run: composer install --no-interaction --prefer-dist
       - uses: actions/download-artifact@v2
         with:
           path: build
-      - run: composer infect:ci
+      - run: composer infect:ci:${{ matrix.test-group }}
 
   upload-coverage:
     needs:
@@ -242,7 +284,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4']
+        php-version: ['8.0']
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

.github/workflows/publish-release.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.0']
         swoole: ['yes', 'no']
     steps:
       - name: Checkout code
@@ -20,7 +20,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.6.3
+          extensions: swoole-4.6.7
       - if: ${{ matrix.swoole == 'yes' }}
         run: ./build.sh ${GITHUB_REF#refs/tags/v}
       - if: ${{ matrix.swoole == 'no' }}
@@ -43,7 +43,6 @@ jobs:
         uses: docker://antonyurchenko/git-release:latest
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          ALLOW_TAG_PREFIX: "true"
           ALLOW_EMPTY_CHANGELOG: "true"
         with:
           args: |
@@ -54,7 +53,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php-version: [ '7.4', '8.0' ]
+        php-version: [ '8.0' ]
         swoole: [ 'yes', 'no' ]
     steps:
       - uses: geekyeggo/delete-artifact@v1

.gitignore

@@ -6,8 +6,7 @@ composer.phar
 vendor/
 data/database.sqlite
 data/shlink-tests.db
-data/GeoLite2-City.mmdb
-data/GeoLite2-City.mmdb.*
+data/GeoLite2-City.*
 docs/swagger-ui*
 docs/mercure.html
 docker-compose.override.yml

CHANGELOG.md

@@ -4,6 +4,241 @@ 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).
 
+## [2.9.2] - 2021-10-23
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1210](https://github.com/shlinkio/shlink/issues/1210) Fixed real time updates not being notified due to an incorrect handling of db transactions on multi-process tasks.
+* [#1211](https://github.com/shlinkio/shlink/issues/1211) Fixed `There is no active transaction` error when running migrations in MySQL/Mariadb after updating to doctrine-migrations 3.3.
+* [#1197](https://github.com/shlinkio/shlink/issues/1197) Fixed amount of task workers provided via config option or env var not being validated to ensure enough workers to process all parallel tasks.
+
+
+## [2.9.1] - 2021-10-11
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1201](https://github.com/shlinkio/shlink/issues/1201) Fixed crash when using the new `USE_HTTPS`, as it's boolean raw value was being used instead of resolving "https" or "http".
+
+
+## [2.9.0] - 2021-10-10
+### Added
+* [#1015](https://github.com/shlinkio/shlink/issues/1015) Shlink now accepts configuration via env vars even when not using docker.
+
+  The config generated with the installing tool still has precedence over the env vars, so it cannot be combined. Either you use the tool, or use env vars.
+
+* [#1149](https://github.com/shlinkio/shlink/issues/1149) Allowed to set custom defaults for the QR codes.
+* [#1112](https://github.com/shlinkio/shlink/issues/1112) Added new option to define if the query string should be forwarded on a per-short URL basis.
+
+  The new `forwardQuery=true|false` param can be provided during short URL creation or edition, via REST API or CLI command, allowing to override the default behavior which makes the query string to always be forwarded.
+
+* [#1105](https://github.com/shlinkio/shlink/issues/1105) Added support to define placeholders on not-found redirects, so that the redirected URL receives the originally visited path and/or domain.
+
+  Currently, `{DOMAIN}` and `{ORIGINAL_PATH}` placeholders are supported, and they can be used both in the redirected URL's path or query.
+
+  When they are used in the query, the values are URL encoded.
+
+* [#1119](https://github.com/shlinkio/shlink/issues/1119) Added support to provide redis sentinel when using redis cache.
+* [#1016](https://github.com/shlinkio/shlink/issues/1016) Added new option to send orphan visits to webhooks, via `NOTIFY_ORPHAN_VISITS_TO_WEBHOOKS` env var or installer tool.
+
+  The option is disabled by default, as the payload is backwards incompatible. You will need to adapt your webhooks to treat the `shortUrl` property as optional before enabling this option.
+
+* [#1104](https://github.com/shlinkio/shlink/issues/1104) Added ability to disable tracking based on IP addresses.
+
+  IP addresses can be provided in the form of fixed addresses, CIDR blocks, or wildcard patterns (192.168.*.*).
+
+### Changed
+* [#1142](https://github.com/shlinkio/shlink/issues/1142) Replaced `doctrine/cache` package with `symfony/cache`.
+* [#1157](https://github.com/shlinkio/shlink/issues/1157) All routes now support CORS, not only rest ones.
+* [#1144](https://github.com/shlinkio/shlink/issues/1144) Added experimental builds under PHP 8.1.
+
+### Deprecated
+* [#1164](https://github.com/shlinkio/shlink/issues/1164) Deprecated `SHORT_DOMAIN_HOST` and `SHORT_DOMAIN_SCHEMA` env vars. Use `DEFAULT_DOMAIN` and `USE_HTTPS=true|false` instead.
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1165](https://github.com/shlinkio/shlink/issues/1165) Fixed warning displayed when trying to locate visits and there are none pending.
+* [#1172](https://github.com/shlinkio/shlink/pull/1172) Removed unneeded explicitly defined volumes in docker image.
+
+
+## [2.8.1] - 2021-08-15
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1155](https://github.com/shlinkio/shlink/issues/1155) Fixed numeric query params in long URLs being replaced by `0`.
+
+
+## [2.8.0] - 2021-08-04
+### Added
+* [#1089](https://github.com/shlinkio/shlink/issues/1089) Added new `ENABLE_PERIODIC_VISIT_LOCATE` env var to docker image which schedules the `visit:locate` command every hour when provided with value `true`.
+* [#1082](https://github.com/shlinkio/shlink/issues/1082) Added support for error correction level on QR codes.
+
+  Now, when calling the `GET /{shorCode}/qr-code` URL, you can pass the `errorCorrection` query param with values `L` for Low, `M` for Medium, `Q` for Quartile or `H` for High.
+
+* [#1080](https://github.com/shlinkio/shlink/issues/1080) Added support to redirect to URLs as soon as the path starts with a valid short code, appending the rest of the path to the redirected long URL.
+
+  With this, if you have the `https://example.com/abc123` short URL redirecting to `https://www.twitter.com`, a visit to `https://example.com/abc123/shlinkio` will take you to `https://www.twitter.com/shlinkio`.
+
+  This behavior needs to be actively opted in, via installer config options or env vars.
+
+* [#943](https://github.com/shlinkio/shlink/issues/943) Added support to define different "not-found" redirects for every domain handled by Shlink.
+
+  Shlink will continue to allow defining the default values via env vars or config, but afterwards, you can use the `domain:redirects` command or the `PATCH /domains/redirects` REST endpoint to define specific values for every single domain.
+
+### Changed
+* [#1118](https://github.com/shlinkio/shlink/issues/1118) Increased phpstan required level to 8.
+* [#1127](https://github.com/shlinkio/shlink/issues/1127) Updated to infection 0.24.
+* [#1139](https://github.com/shlinkio/shlink/issues/1139) Updated project dependencies, including base docker image to use PHP 8.0.9 and Alpine 3.14.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* [#1046](https://github.com/shlinkio/shlink/issues/1046) Dropped support for PHP 7.4.
+
+### Fixed
+* [#1098](https://github.com/shlinkio/shlink/issues/1098) Fixed errors when using Redis for caching, caused by some third party lib bug that was fixed on dependencies update.
+
+
+## [2.7.3] - 2021-08-02
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1135](https://github.com/shlinkio/shlink/issues/1135) Fixed error when importing short URLs with no visits from another Shlink instance.
+* [#1136](https://github.com/shlinkio/shlink/issues/1136) Fixed error when fetching tag/short-url/orphan visits for a page lower than 1.
+
+
+## [2.7.2] - 2021-07-30
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1128](https://github.com/shlinkio/shlink/issues/1128) Increased memory limit reserved for the docker image, preventing it from crashing on GeoLite db download.
+
+
+## [2.7.1] - 2021-05-30
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1100](https://github.com/shlinkio/shlink/issues/1100) Fixed Shlink trying to download GeoLite2 db files even when tracking has been disabled.
+
+
+## [2.7.0] - 2021-05-23
+### Added
+* [#1044](https://github.com/shlinkio/shlink/issues/1044) Added ability to set names on API keys, which helps to identify them when the list grows.
+* [#819](https://github.com/shlinkio/shlink/issues/819) Visits are now always located in real time, even when not using swoole.
+
+    The only side effect is that a GeoLite2 db file is now installed when the docker image starts or during shlink installation or update.
+
+    Also, when using swoole, the file is now updated **after** tracking a visit, which means it will not apply until the next one.
+
+* [#1059](https://github.com/shlinkio/shlink/issues/1059) Added ability to optionally display author API key and its name when listing short URLs from the command line.
+* [#1066](https://github.com/shlinkio/shlink/issues/1066) Added support to import short URLs and their visits from another Shlink instance using its API.
+* [#898](https://github.com/shlinkio/shlink/issues/898) Improved tracking granularity, allowing to disable visits tracking completely, or just parts of it.
+
+    In order to achieve it, Shlink now supports 4 new tracking-related options, that can be customized via env vars for docker, or via installer:
+
+    * `disable_tracking`: If true, visits will not be tracked at all.
+    * `disable_ip_tracking`: If true, visits will be tracked, but neither the IP address, nor the location will be resolved.
+    * `disable_referrer_tracking`: If true, the referrer will not be tracked.
+    * `disable_ua_tracking`: If true, the user agent will not be tracked.
+
+* [#955](https://github.com/shlinkio/shlink/issues/955) Added new option to set short URLs as crawlable, making them be listed in the robots.txt as Allowed.
+* [#900](https://github.com/shlinkio/shlink/issues/900) Shlink now tries to detect if the visit is coming from a potential bot or crawler, and allows to exclude those visits from visits lists if desired.
+
+### Changed
+* [#1036](https://github.com/shlinkio/shlink/issues/1036) Updated to `happyr/doctrine-specification` 2.0.
+* [#1039](https://github.com/shlinkio/shlink/issues/1039) Updated to `endroid/qr-code` 4.0.
+* [#1008](https://github.com/shlinkio/shlink/issues/1008) Ensured all logs are sent to the filesystem while running API tests, which helps debugging the reason for tests to fail.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1041](https://github.com/shlinkio/shlink/issues/1041) Ensured the default value for the version while building the docker image is `latest`.
+* [#1067](https://github.com/shlinkio/shlink/issues/1067) Fixed exception when persisting multiple short URLs in one batch which include the same new tags/domains. This can potentially happen when importing URLs.
+
+
+## [2.6.2] - 2021-03-12
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1047](https://github.com/shlinkio/shlink/issues/1047) Fixed error in migrations when doing a fresh installation using PHP8 and MySQL/Mariadb databases.
+
+
 ## [2.6.1] - 2021-02-22
 ### Added
 * *Nothing*

CONTRIBUTING.md

@@ -96,11 +96,13 @@ In order to ensure stability and no regressions are introduced while developing
 
     The project provides some tooling to run them against any of the supported database engines.
 
-* **API tests**: These are E2E tests that spin up an instance of the app and test it from the outside, by interacting with the REST API.
+* **API tests**: These are E2E tests that spin up an instance of the app with swoole, and test it from the outside by interacting with the REST API.
 
     These are the best tests to catch regressions, and to verify everything behaves as expected.
 
-    They use MySQL as the database engine, and include some fixtures that ensure the same data exists at the beginning of the execution.
+    They use Postgres as the database engine, and include some fixtures that ensure the same data exists at the beginning of the execution.
+
+    Since the app instance is run on a process different from the one running the tests, when a test fails it might not be obvious why. To help debugging that, the app will dump all its logs inside `data/log/api-tests`, where you will find the `shlink.log` and `access.log` files.
 
 * **CLI tests**: *TBD. Once included, its purpose will be the same as API tests, but running through the command line*
 
@@ -118,8 +120,8 @@ Depending on the kind of contribution, maybe not all kinds of tests are needed,
     
     For example, `test:db:postgres`.
 
-* Run `./indocker composer test:api` to run API E2E tests. For these, the MySQL database engine is used.
-* Run `./indocker composer infect:test` ti run both unit and database tests (over sqlite) and then apply mutations to them with [infection](https://infection.github.io/).
+* Run `./indocker composer test:api` to run API E2E tests. For these, the Postgres database engine is used.
+* Run `./indocker composer infect:test` to run both unit and database tests (over sqlite) and then apply mutations to them with [infection](https://infection.github.io/).
 * Run `./indocker composer ci` to run all previous commands together. This command is run during the project's continuous integration.
 * Run `./indocker composer ci:parallel` to do the same as in previous case, but parallelizing non-conflicting tasks as much as possible.
 

Dockerfile

@@ -1,9 +1,10 @@
-FROM php:8.0.2-alpine3.13 as base
+FROM php:8.0.9-alpine3.14 as base
 
-ARG SHLINK_VERSION=2.5.2
+ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}
-ENV SWOOLE_VERSION 4.6.3
+ENV SWOOLE_VERSION 4.7.1
 ENV PDO_SQLSRV_VERSION 5.9.0
+ENV MS_ODBC_SQL_VERSION 17.5.2.2
 ENV LC_ALL "C"
 
 WORKDIR /etc/shlink
@@ -30,13 +31,13 @@ RUN \
 
 # Install sqlsrv driver
 RUN if [ $(uname -m) == "x86_64" ]; then \
-      wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
-      apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+      wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+      apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
       apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
       pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} && \
       docker-php-ext-enable pdo_sqlsrv && \
       apk del .phpize-deps && \
-      rm msodbcsql17_17.5.1.1-1_amd64.apk ; \
+      rm msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk ; \
     fi
 
 # Install swoole
@@ -67,12 +68,19 @@ RUN ln -s /etc/shlink/bin/cli /usr/local/bin/shlink
 # Expose default swoole port
 EXPOSE 8080
 
-# Expose params config dir, since the user is expected to provide custom config from there
-VOLUME /etc/shlink/config/params
-
 # Copy config specific for the image
 COPY docker/docker-entrypoint.sh docker-entrypoint.sh
 COPY docker/config/shlink_in_docker.local.php config/autoload/shlink_in_docker.local.php
 COPY docker/config/php.ini ${PHP_INI_DIR}/conf.d/
 
+# Change the ownership of /etc/shlink/data to be writable, then change the user to non-root
+# FIXME Disabled for now, as it conflicts with ENABLE_PERIODIC_VISIT_LOCATE, which is used to configure a cron as root.
+#       Ref: https://github.com/shlinkio/shlink/issues/1132
+#RUN chown 1001 /etc/shlink/data
+#RUN chown 1001 /etc/shlink/data/locks
+#RUN chown 1001 /etc/shlink/data/proxies
+#RUN chown 1001 /etc/shlink/data/cache
+#RUN chown 1001 /etc/shlink/data/log
+#USER 1001
+
 ENTRYPOINT ["/bin/sh", "./docker-entrypoint.sh"]

README.md

@@ -33,7 +33,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 7.4 or 8.0
+* PHP 8.0
 * The next PHP extensions: json, curl, pdo, intl, gd and gmp.
     * apcu extension is recommended if you don't plan to use swoole.
     * xml extension is required if you want to generate QR codes in svg format.

bin/cli

@@ -3,5 +3,8 @@
 
 declare(strict_types=1);
 
-$run = require __DIR__ . '/../config/run.php';
-$run(true);
+use Symfony\Component\Console\Application;
+
+/** @var Application $app */
+$app = require __DIR__ . '/../config/cli-app.php';
+$app->run();

bin/test/run-api-tests.sh

@@ -3,6 +3,8 @@ export APP_ENV=test
 export DB_DRIVER=postgres
 export TEST_ENV=api
 
+rm -rf data/log/api-tests
+
 # Try to stop server just in case it hanged in last execution
 vendor/bin/laminas mezzio:swoole:stop
 

composer.json

@@ -12,67 +12,70 @@
         }
     ],
     "require": {
-        "php": "^7.4 || ^8.0",
+        "php": "^8.0",
         "ext-json": "*",
         "ext-pdo": "*",
         "akrabat/ip-address-middleware": "^2.0",
-        "cakephp/chronos": "^2.0",
+        "cakephp/chronos": "^2.2",
         "cocur/slugify": "^4.0",
-        "doctrine/cache": "^1.9",
-        "doctrine/migrations": "^3.0.2",
-        "doctrine/orm": "2.8.1 || ^2.8.3",
-        "endroid/qr-code": "dev-master#0f1613a as 3.10",
-        "geoip2/geoip2": "^2.9",
-        "guzzlehttp/guzzle": "^7.0",
-        "happyr/doctrine-specification": "2.0.x-dev#cb116d3 as 2.0",
-        "laminas/laminas-config": "^3.3",
-        "laminas/laminas-config-aggregator": "^1.1",
-        "laminas/laminas-diactoros": "^2.1.3",
-        "laminas/laminas-inputfilter": "^2.10",
-        "laminas/laminas-servicemanager": "^3.6",
-        "laminas/laminas-stdlib": "^3.2",
-        "lcobucci/jwt": "^4.0",
-        "league/uri": "^6.2",
-        "lstrojny/functional-php": "^1.15",
-        "mezzio/mezzio": "^3.3",
-        "mezzio/mezzio-fastroute": "^3.1",
-        "mezzio/mezzio-problem-details": "^1.3",
+        "doctrine/migrations": "^3.3",
+        "doctrine/orm": "^2.9",
+        "endroid/qr-code": "^4.2",
+        "geoip2/geoip2": "^2.11",
+        "guzzlehttp/guzzle": "^7.3",
+        "happyr/doctrine-specification": "^2.0",
+        "jaybizzle/crawler-detect": "^1.2",
+        "laminas/laminas-config": "^3.5",
+        "laminas/laminas-config-aggregator": "^1.5",
+        "laminas/laminas-diactoros": "^2.6",
+        "laminas/laminas-inputfilter": "^2.12",
+        "laminas/laminas-servicemanager": "^3.7",
+        "laminas/laminas-stdlib": "^3.5",
+        "lcobucci/jwt": "^4.1",
+        "league/uri": "^6.4",
+        "lstrojny/functional-php": "^1.17",
+        "mezzio/mezzio": "^3.5",
+        "mezzio/mezzio-fastroute": "^3.2",
+        "mezzio/mezzio-problem-details": "^1.4",
         "mezzio/mezzio-swoole": "^3.3",
-        "monolog/monolog": "^2.0",
+        "monolog/monolog": "^2.3",
         "nikolaposa/monolog-factory": "^3.1",
         "ocramius/proxy-manager": "^2.11",
-        "pagerfanta/core": "^2.5",
+        "pagerfanta/core": "^2.7",
         "php-middleware/request-id": "^4.1",
         "predis/predis": "^1.1",
         "pugx/shortid-php": "^0.7",
         "ramsey/uuid": "^3.9",
-        "shlinkio/shlink-common": "^3.5",
-        "shlinkio/shlink-config": "^1.0",
+        "rlanvin/php-ip": "3.0.0-rc2",
+        "shlinkio/shlink-common": "^4.0",
+        "shlinkio/shlink-config": "^1.2",
         "shlinkio/shlink-event-dispatcher": "^2.1",
-        "shlinkio/shlink-importer": "^2.2",
-        "shlinkio/shlink-installer": "^5.4",
-        "shlinkio/shlink-ip-geolocation": "^1.5",
-        "symfony/console": "^5.1",
-        "symfony/filesystem": "^5.1",
-        "symfony/lock": "^5.1",
-        "symfony/mercure": "^0.4.1",
-        "symfony/process": "^5.1",
-        "symfony/string": "^5.1"
+        "shlinkio/shlink-importer": "^2.3.1",
+        "shlinkio/shlink-installer": "^6.2.1",
+        "shlinkio/shlink-ip-geolocation": "^2.0",
+        "symfony/console": "^5.3",
+        "symfony/filesystem": "^5.3",
+        "symfony/lock": "^5.3",
+        "symfony/mercure": "^0.5.3",
+        "symfony/process": "^5.3",
+        "symfony/string": "^5.3"
     },
     "require-dev": {
         "devster/ubench": "^2.1",
-        "dms/phpunit-arraysubset-asserts": "^0.2.1",
+        "dms/phpunit-arraysubset-asserts": "^0.3.0",
         "eaglewu/swoole-ide-helper": "dev-master",
-        "infection/infection": "^0.21.0",
+        "infection/infection": "^0.25.0",
         "phpspec/prophecy-phpunit": "^2.0",
-        "phpstan/phpstan": "^0.12.64",
+        "phpstan/phpstan": "^0.12.94",
+        "phpstan/phpstan-doctrine": "^0.12.42",
+        "phpstan/phpstan-symfony": "^0.12.41",
         "phpunit/php-code-coverage": "^9.2",
         "phpunit/phpunit": "^9.5",
         "roave/security-advisories": "dev-master",
-        "shlinkio/php-coding-standard": "~2.1.1",
-        "shlinkio/shlink-test-utils": "^2.0",
-        "symfony/var-dumper": "^5.2",
-        "veewee/composer-run-parallel": "^0.1.0"
+        "shlinkio/php-coding-standard": "~2.2.0",
+        "shlinkio/shlink-test-utils": "^2.3",
+        "symfony/var-dumper": "^5.3",
+        "veewee/composer-run-parallel": "^1.0"
     },
     "autoload": {
         "psr-4": {
@@ -81,6 +84,7 @@
             "Shlinkio\\Shlink\\Core\\": "module/Core/src"
         },
         "files": [
+            "config/constants.php",
             "module/Core/functions/functions.php"
         ]
     },
@@ -111,7 +115,7 @@
         ],
         "cs": "phpcs",
         "cs:fix": "phpcbf",
-        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config data/migrations --level=6",
+        "stan": "APP_ENV=test php vendor/bin/phpstan analyse module/*/src module/*/config config docker/config data/migrations --level=8",
         "test": [
             "@test:unit",
             "@test:db",
@@ -124,6 +128,7 @@
         ],
         "test:unit": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-unit.cov --testdox",
         "test:unit:ci": "@test:unit --coverage-xml=build/coverage-unit/coverage-xml --log-junit=build/coverage-unit/junit.xml",
+        "test:unit:pretty": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage-unit-html",
         "test:db": "@parallel test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
         "test:db:sqlite": "APP_ENV=test php vendor/bin/phpunit --order-by=random --colors=always --testdox -c phpunit-db.xml",
         "test:db:sqlite:ci": "@test:db:sqlite --coverage-php build/coverage-db.cov --coverage-xml=build/coverage-db/coverage-xml --log-junit=build/coverage-db/junit.xml",
@@ -132,8 +137,7 @@
         "test:db:postgres": "DB_DRIVER=postgres composer test:db:sqlite",
         "test:db:ms": "DB_DRIVER=mssql composer test:db:sqlite",
         "test:api": "bin/test/run-api-tests.sh",
-        "test:unit:pretty": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage-unit-html",
-        "infect:ci:base": "infection --threads=4 --log-verbosity=default --only-covered --skip-initial-tests",
+        "infect:ci:base": "infection --threads=4 --log-verbosity=default --only-covered --only-covering-test-cases --skip-initial-tests",
         "infect:ci:unit": "@infect:ci:base --coverage=build/coverage-unit --min-msi=80",
         "infect:ci:db": "@infect:ci:base --coverage=build/coverage-db --min-msi=95 --configuration=infection-db.json",
         "infect:ci": "@parallel infect:ci:unit infect:ci:db",

config/autoload/app_options.global.php

@@ -7,7 +7,6 @@ return [
     'app_options' => [
         'name' => 'Shlink',
         'version' => '%SHLINK_VERSION%',
-        'disable_track_param' => null,
     ],
 
 ];

config/autoload/delete_short_urls.global.php

@@ -4,11 +4,15 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
+use function Shlinkio\Shlink\Common\env;
+
+use const Shlinkio\Shlink\DEFAULT_DELETE_SHORT_URL_THRESHOLD;
+
 return [
 
     'delete_short_urls' => [
-        'visits_threshold' => 15,
         'check_visits_threshold' => true,
+        'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', DEFAULT_DELETE_SHORT_URL_THRESHOLD),
     ],
 
 ];

config/autoload/entity-manager.global.php

@@ -2,24 +2,52 @@
 
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common;
+use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepository;
 
-use Happyr\DoctrineSpecification\EntitySpecificationRepository;
+use function Functional\contains;
+use function Shlinkio\Shlink\Common\env;
 
-return [
+return (static function (): array {
+    $driver = env('DB_DRIVER');
+    $isMysqlCompatible = contains(['maria', 'mysql'], $driver);
 
-    'entity_manager' => [
-        'orm' => [
-            'proxies_dir' => 'data/proxies',
-            'load_mappings_using_functional_style' => true,
-            'default_repository_classname' => EntitySpecificationRepository::class,
+    $resolveDriver = static fn () => match ($driver) {
+        'postgres' => 'pdo_pgsql',
+        'mssql' => 'pdo_sqlsrv',
+        default => 'pdo_mysql',
+    };
+    $resolveDefaultPort = static fn () => match ($driver) {
+        'postgres' => '5432',
+        'mssql' => '1433',
+        default => '3306',
+    };
+    $resolveConnection = static fn () => match (true) {
+        $driver === null || $driver === 'sqlite' => [
+            'driver' => 'pdo_sqlite',
+            'path' => 'data/database.sqlite',
         ],
-        'connection' => [
-            'user' => '',
-            'password' => '',
-            'dbname' => 'shlink',
+        default => [
+            'driver' => $resolveDriver(),
+            'dbname' => env('DB_NAME', 'shlink'),
+            'user' => env('DB_USER'),
+            'password' => env('DB_PASSWORD'),
+            'host' => env('DB_HOST', $driver === 'postgres' ? env('DB_UNIX_SOCKET') : null),
+            'port' => env('DB_PORT', $resolveDefaultPort()),
+            'unix_socket' => $isMysqlCompatible ? env('DB_UNIX_SOCKET') : null,
             'charset' => 'utf8',
         ],
-    ],
+    };
 
-];
+    return [
+
+        'entity_manager' => [
+            'orm' => [
+                'proxies_dir' => 'data/proxies',
+                'load_mappings_using_functional_style' => true,
+                'default_repository_classname' => EntitySpecificationRepository::class,
+            ],
+            'connection' => $resolveConnection(),
+        ],
+
+    ];
+})();

config/autoload/entity-manager.local.php.dist

@@ -2,14 +2,6 @@
 
 declare(strict_types=1);
 
-use function Shlinkio\Shlink\Common\env;
-
-// When running tests, any mysql-specific option can interfere with other drivers
-$driverOptions = env('APP_ENV') === 'test' ? [] : [
-    PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
-    PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true,
-];
-
 return [
 
     'entity_manager' => [
@@ -18,7 +10,8 @@ return [
             'password' => 'root',
             'driver' => 'pdo_mysql',
             'host' => 'shlink_db',
-            'driverOptions' => $driverOptions,
+            'dbname' => 'shlink',
+            'charset' => 'utf8',
         ],
     ],
 

config/autoload/geolite2.global.php

@@ -2,12 +2,14 @@
 
 declare(strict_types=1);
 
+use function Shlinkio\Shlink\Common\env;
+
 return [
 
     'geolite2' => [
         'db_location' => __DIR__ . '/../../data/GeoLite2-City.mmdb',
         'temp_dir' => __DIR__ . '/../../data',
-        'license_key' => 'G4Lm0C60yJsnkdPi', // Deprecated. Remove hardcoded license on v3
+        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'), // Deprecated. Remove hardcoded license on v3
     ],
 
 ];

config/autoload/installer.global.php

@@ -2,7 +2,10 @@
 
 declare(strict_types=1);
 
+namespace Shlinkio\Shlink\CLI;
+
 use Shlinkio\Shlink\Installer\Config\Option;
+use Shlinkio\Shlink\Installer\Util\InstallationCommand;
 
 return [
 
@@ -21,10 +24,10 @@ return [
             Option\UrlShortener\ShortDomainSchemaConfigOption::class,
             Option\UrlShortener\ValidateUrlConfigOption::class,
             Option\Visit\VisitsWebhooksConfigOption::class,
+            Option\Visit\OrphanVisitsWebhooksConfigOption::class,
             Option\Redirect\BaseUrlRedirectConfigOption::class,
             Option\Redirect\InvalidShortUrlRedirectConfigOption::class,
             Option\Redirect\Regular404RedirectConfigOption::class,
-            Option\DisableTrackParamConfigOption::class,
             Option\Visit\CheckVisitsThresholdConfigOption::class,
             Option\Visit\VisitsThresholdConfigOption::class,
             Option\BasePathConfigOption::class,
@@ -37,19 +40,33 @@ return [
             Option\Mercure\MercureInternalUrlConfigOption::class,
             Option\Mercure\MercureJwtSecretConfigOption::class,
             Option\UrlShortener\GeoLiteLicenseKeyConfigOption::class,
-            Option\UrlShortener\IpAnonymizationConfigOption::class,
             Option\UrlShortener\RedirectStatusCodeConfigOption::class,
             Option\UrlShortener\RedirectCacheLifeTimeConfigOption::class,
             Option\UrlShortener\AutoResolveTitlesConfigOption::class,
-            Option\UrlShortener\OrphanVisitsTrackingConfigOption::class,
+            Option\UrlShortener\AppendExtraPathConfigOption::class,
+            Option\Tracking\IpAnonymizationConfigOption::class,
+            Option\Tracking\OrphanVisitsTrackingConfigOption::class,
+            Option\Tracking\DisableTrackParamConfigOption::class,
+            Option\Tracking\DisableTrackingFromConfigOption::class,
+            Option\Tracking\DisableTrackingConfigOption::class,
+            Option\Tracking\DisableIpTrackingConfigOption::class,
+            Option\Tracking\DisableReferrerTrackingConfigOption::class,
+            Option\Tracking\DisableUaTrackingConfigOption::class,
+            Option\QrCode\DefaultSizeConfigOption::class,
+            Option\QrCode\DefaultMarginConfigOption::class,
+            Option\QrCode\DefaultFormatConfigOption::class,
+            Option\QrCode\DefaultErrorCorrectionConfigOption::class,
         ],
 
         'installation_commands' => [
-            'db_create_schema' => [
-                'command' => 'bin/cli db:create',
+            InstallationCommand::DB_CREATE_SCHEMA => [
+                'command' => 'bin/cli ' . Command\Db\CreateDatabaseCommand::NAME,
             ],
-            'db_migrate' => [
-                'command' => 'bin/cli db:migrate',
+            InstallationCommand::DB_MIGRATE => [
+                'command' => 'bin/cli ' . Command\Db\MigrateDatabaseCommand::NAME,
+            ],
+            InstallationCommand::GEOLITE_DOWNLOAD_DB => [
+                'command' => 'bin/cli ' . Command\Visit\DownloadGeoLiteDbCommand::NAME,
             ],
         ],
     ],

config/autoload/locks.global.php

@@ -3,12 +3,13 @@
 declare(strict_types=1);
 
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
-use Shlinkio\Shlink\Common\Cache\RedisFactory;
-use Shlinkio\Shlink\Common\Lock\RetryLockStoreDelegatorFactory;
+use Predis\ClientInterface as PredisClient;
 use Shlinkio\Shlink\Common\Logger\LoggerAwareDelegatorFactory;
 use Symfony\Component\Lock;
 
-use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
+use function Shlinkio\Shlink\Common\env;
+
+use const Shlinkio\Shlink\LOCAL_LOCK_FACTORY;
 
 return [
 
@@ -24,16 +25,12 @@ return [
             LOCAL_LOCK_FACTORY => ConfigAbstractFactory::class,
         ],
         'aliases' => [
-            // With this config, a user could alias 'lock_store' => 'redis_lock_store' to override the default
-            'lock_store' => 'local_lock_store',
+            'lock_store' => env('REDIS_SERVERS') === null ? 'local_lock_store' : 'redis_lock_store',
 
             'redis_lock_store' => Lock\Store\RedisStore::class,
             'local_lock_store' => Lock\Store\FlockStore::class,
         ],
         'delegators' => [
-            Lock\Store\RedisStore::class => [
-                RetryLockStoreDelegatorFactory::class,
-            ],
             Lock\LockFactory::class => [
                 LoggerAwareDelegatorFactory::class,
             ],
@@ -42,7 +39,7 @@ return [
 
     ConfigAbstractFactory::class => [
         Lock\Store\FlockStore::class => ['config.locks.locks_dir'],
-        Lock\Store\RedisStore::class => [RedisFactory::SERVICE_NAME],
+        Lock\Store\RedisStore::class => [PredisClient::class],
         Lock\LockFactory::class => ['lock_store'],
         LOCAL_LOCK_FACTORY => ['local_lock_store'],
     ],

config/autoload/mercure.global.php

@@ -4,33 +4,39 @@ declare(strict_types=1);
 
 use Laminas\ServiceManager\Proxy\LazyServiceFactory;
 use Shlinkio\Shlink\Common\Mercure\LcobucciJwtProvider;
-use Symfony\Component\Mercure\Publisher;
-use Symfony\Component\Mercure\PublisherInterface;
+use Symfony\Component\Mercure\Hub;
+use Symfony\Component\Mercure\HubInterface;
 
-return [
+use function Shlinkio\Shlink\Common\env;
 
-    'mercure' => [
-        'public_hub_url' => null,
-        'internal_hub_url' => null,
-        'jwt_secret' => null,
-        'jwt_issuer' => 'Shlink',
-    ],
+return (static function (): array {
+    $publicUrl = env('MERCURE_PUBLIC_HUB_URL');
 
-    'dependencies' => [
-        'delegators' => [
-            LcobucciJwtProvider::class => [
-                LazyServiceFactory::class,
+    return [
+
+        'mercure' => [
+            'public_hub_url' => $publicUrl,
+            'internal_hub_url' => env('MERCURE_INTERNAL_HUB_URL', $publicUrl),
+            'jwt_secret' => env('MERCURE_JWT_SECRET'),
+            'jwt_issuer' => 'Shlink',
+        ],
+
+        'dependencies' => [
+            'delegators' => [
+                LcobucciJwtProvider::class => [
+                    LazyServiceFactory::class,
+                ],
+                Hub::class => [
+                    LazyServiceFactory::class,
+                ],
             ],
-            Publisher::class => [
-                LazyServiceFactory::class,
+            'lazy_services' => [
+                'class_map' => [
+                    LcobucciJwtProvider::class => LcobucciJwtProvider::class,
+                    Hub::class => HubInterface::class,
+                ],
             ],
         ],
-        'lazy_services' => [
-            'class_map' => [
-                LcobucciJwtProvider::class => LcobucciJwtProvider::class,
-                Publisher::class => PublisherInterface::class,
-            ],
-        ],
-    ],
 
-];
+    ];
+})();

config/autoload/middleware-pipeline.global.php

@@ -18,12 +18,12 @@ return [
             'middleware' => [
                 ContentLengthMiddleware::class,
                 ErrorHandler::class,
+                Rest\Middleware\CrossDomainMiddleware::class,
             ],
         ],
         'error-handler-rest' => [
             'path' => '/rest',
             'middleware' => [
-                Rest\Middleware\CrossDomainMiddleware::class,
                 RequestIdMiddleware::class,
                 ProblemDetails\ProblemDetailsMiddleware::class,
             ],
@@ -68,6 +68,7 @@ return [
                 // This middleware is in front of tracking actions explicitly. Putting here for orphan visits tracking
                 IpAddress::class,
                 Core\ErrorHandler\NotFoundTypeResolverMiddleware::class,
+                Core\ShortUrl\Middleware\ExtraPathRedirectMiddleware::class,
                 Core\ErrorHandler\NotFoundTrackerMiddleware::class,
                 Core\ErrorHandler\NotFoundRedirectHandler::class,
                 Core\ErrorHandler\NotFoundTemplateHandler::class,

config/autoload/qr-codes.global.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use function Shlinkio\Shlink\Common\env;
+
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_ERROR_CORRECTION;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_FORMAT;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_MARGIN;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_SIZE;
+
+return [
+
+    'qr_codes' => [
+        'size' => (int) env('DEFAULT_QR_CODE_SIZE', DEFAULT_QR_CODE_SIZE),
+        'margin' => (int) env('DEFAULT_QR_CODE_MARGIN', DEFAULT_QR_CODE_MARGIN),
+        'format' => env('DEFAULT_QR_CODE_FORMAT', DEFAULT_QR_CODE_FORMAT),
+        'error_correction' => env('DEFAULT_QR_CODE_ERROR_CORRECTION', DEFAULT_QR_CODE_ERROR_CORRECTION),
+    ],
+
+];

config/autoload/redirects.global.php

@@ -2,12 +2,23 @@
 
 declare(strict_types=1);
 
+use function Shlinkio\Shlink\Common\env;
+
+use const Shlinkio\Shlink\DEFAULT_REDIRECT_CACHE_LIFETIME;
+use const Shlinkio\Shlink\DEFAULT_REDIRECT_STATUS_CODE;
+
 return [
 
     'not_found_redirects' => [
-        'invalid_short_url' => null,
-        'regular_404' => null,
-        'base_url' => null,
+        'invalid_short_url' => env('INVALID_SHORT_URL_REDIRECT_TO'),
+        'regular_404' => env('REGULAR_404_REDIRECT_TO'),
+        'base_url' => env('BASE_URL_REDIRECT_TO'),
+    ],
+
+    'url_shortener' => [
+        // TODO Move these options to their own config namespace. Maybe "redirects".
+        'redirect_status_code' => (int) env('REDIRECT_STATUS_CODE', DEFAULT_REDIRECT_STATUS_CODE),
+        'redirect_cache_lifetime' => (int) env('REDIRECT_CACHE_LIFETIME', DEFAULT_REDIRECT_CACHE_LIFETIME),
     ],
 
 ];

config/autoload/redis.global.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use function Shlinkio\Shlink\Common\env;
+
+return (static function (): array {
+    $redisServers = env('REDIS_SERVERS');
+
+    return match (true) {
+        $redisServers === null => [],
+        default => [
+            'cache' => [
+                'redis' => [
+                    'servers' => $redisServers,
+                    'sentinel_service' => env('REDIS_SENTINEL_SERVICE'),
+                ],
+            ],
+        ],
+    };
+})();

config/autoload/router.global.php

@@ -4,10 +4,12 @@ declare(strict_types=1);
 
 use Mezzio\Router\FastRouteRouter;
 
+use function Shlinkio\Shlink\Common\env;
+
 return [
 
     'router' => [
-        'base_path' => '',
+        'base_path' => env('BASE_PATH', ''),
 
         'fastroute' => [
             FastRouteRouter::CONFIG_CACHE_ENABLED => true,

config/autoload/swoole.global.php

@@ -2,21 +2,30 @@
 
 declare(strict_types=1);
 
-return [
+use function Shlinkio\Shlink\Common\env;
 
-    'mezzio-swoole' => [
-        // Setting this to true can have unexpected behaviors when running several concurrent slow DB queries
-        'enable_coroutine' => false,
+use const Shlinkio\Shlink\MIN_TASK_WORKERS;
 
-        'swoole-http-server' => [
-            'host' => '0.0.0.0',
-            'process-name' => 'shlink',
+return (static function () {
+    $taskWorkers = (int) env('TASK_WORKER_NUM', 16);
 
-            'options' => [
-                'worker_num' => 16,
-                'task_worker_num' => 16,
+    return [
+
+        'mezzio-swoole' => [
+            // Setting this to true can have unexpected behaviors when running several concurrent slow DB queries
+            'enable_coroutine' => false,
+
+            'swoole-http-server' => [
+                'host' => '0.0.0.0',
+                'port' => (int) env('PORT', 8080),
+                'process-name' => 'shlink',
+
+                'options' => [
+                    'worker_num' => (int) env('WEB_WORKER_NUM', 16),
+                    'task_worker_num' => $taskWorkers < MIN_TASK_WORKERS ? MIN_TASK_WORKERS : $taskWorkers,
+                ],
             ],
         ],
-    ],
 
-];
+    ];
+})();

config/autoload/tracking.global.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+use function Shlinkio\Shlink\Common\env;
+
+return [
+
+    'tracking' => [
+        // Tells if IP addresses should be anonymized before persisting, to fulfil data protection regulations
+        // This applies only if IP address tracking is enabled
+        'anonymize_remote_addr' => (bool) env('ANONYMIZE_REMOTE_ADDR', true),
+
+        // Tells if visits to not-found URLs should be tracked. The disable_tracking option takes precedence
+        'track_orphan_visits' => (bool) env('TRACK_ORPHAN_VISITS', true),
+
+        // A query param that, if provided, will disable tracking of one particular visit. Always takes precedence
+        'disable_track_param' => env('DISABLE_TRACK_PARAM'),
+
+        // If true, visits will not be tracked at all
+        'disable_tracking' => (bool) env('DISABLE_TRACKING', false),
+
+        // If true, visits will be tracked, but neither the IP address, nor the location will be resolved
+        'disable_ip_tracking' => (bool) env('DISABLE_IP_TRACKING', false),
+
+        // If true, the referrer will not be tracked
+        'disable_referrer_tracking' => (bool) env('DISABLE_REFERRER_TRACKING', false),
+
+        // If true, the user agent will not be tracked
+        'disable_ua_tracking' => (bool) env('DISABLE_UA_TRACKING', false),
+
+        // A list of IP addresses, patterns or CIDR blocks from which tracking is disabled by default
+        'disable_tracking_from' => env('DISABLE_TRACKING_FROM'),
+    ],
+
+];

config/autoload/url-shortener.global.php

@@ -2,25 +2,37 @@
 
 declare(strict_types=1);
 
-use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_CACHE_LIFETIME;
-use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_STATUS_CODE;
-use const Shlinkio\Shlink\Core\DEFAULT_SHORT_CODES_LENGTH;
+use function Shlinkio\Shlink\Common\env;
 
-return [
+use const Shlinkio\Shlink\DEFAULT_SHORT_CODES_LENGTH;
+use const Shlinkio\Shlink\MIN_SHORT_CODES_LENGTH;
 
-    'url_shortener' => [
-        'domain' => [
-            'schema' => 'https',
-            'hostname' => '',
+return (static function (): array {
+    $shortCodesLength = (int) env('DEFAULT_SHORT_CODES_LENGTH', DEFAULT_SHORT_CODES_LENGTH);
+    $shortCodesLength = $shortCodesLength < MIN_SHORT_CODES_LENGTH ? MIN_SHORT_CODES_LENGTH : $shortCodesLength;
+    $resolveSchema = static function (): string {
+        $useHttps = env('USE_HTTPS'); // Deprecated. For v3, set this to true by default, instead of null
+        if ($useHttps !== null) {
+            $boolUseHttps = (bool) $useHttps;
+            return $boolUseHttps ? 'https' : 'http';
+        }
+
+        return env('SHORT_DOMAIN_SCHEMA', 'http');
+    };
+
+    return [
+
+        'url_shortener' => [
+            'domain' => [
+                // Deprecated SHORT_DOMAIN_* env vars
+                'schema' => $resolveSchema(),
+                'hostname' => env('DEFAULT_DOMAIN', env('SHORT_DOMAIN_HOST', '')),
+            ],
+            'validate_url' => (bool) env('VALIDATE_URLS', false), // Deprecated
+            'default_short_codes_length' => $shortCodesLength,
+            'auto_resolve_titles' => (bool) env('AUTO_RESOLVE_TITLES', false),
+            'append_extra_path' => (bool) env('REDIRECT_APPEND_EXTRA_PATH', false),
         ],
-        'validate_url' => false, // Deprecated
-        'anonymize_remote_addr' => true,
-        'visits_webhooks' => [],
-        'default_short_codes_length' => DEFAULT_SHORT_CODES_LENGTH,
-        'redirect_status_code' => DEFAULT_REDIRECT_STATUS_CODE,
-        'redirect_cache_lifetime' => DEFAULT_REDIRECT_CACHE_LIFETIME,
-        'auto_resolve_titles' => false,
-        'track_orphan_visits' => true,
-    ],
 
-];
+    ];
+})();

config/autoload/url-shortener.local.php.dist

@@ -2,13 +2,16 @@
 
 declare(strict_types=1);
 
+$isSwoole = extension_loaded('swoole');
+
 return [
 
     'url_shortener' => [
         'domain' => [
             'schema' => 'http',
-            'hostname' => 'localhost:8080',
+            'hostname' => sprintf('localhost:%s', $isSwoole ? '8080' : '8000'),
         ],
+        'auto_resolve_titles' => true,
     ],
 
 ];

config/autoload/webhooks.global.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use function Shlinkio\Shlink\Common\env;
+
+return (static function (): array {
+    $webhooks = env('VISITS_WEBHOOKS');
+
+    return [
+
+        'url_shortener' => [
+            // TODO Move these options to their own config namespace
+            'visits_webhooks' => $webhooks === null ? [] : explode(',', $webhooks),
+            'notify_orphan_visits_to_webhooks' => (bool) env('NOTIFY_ORPHAN_VISITS_TO_WEBHOOKS', false),
+        ],
+
+    ];
+})();

config/cli-app.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Psr\Container\ContainerInterface;
+use Symfony\Component\Console\Application as CliApp;
+
+return (static function () {
+    /** @var ContainerInterface $container */
+    $container = include __DIR__ . '/container.php';
+    return $container->get(CliApp::class);
+})();

config/cli-config.php

@@ -4,12 +4,9 @@ declare(strict_types=1);
 
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Tools\Console\ConsoleRunner;
-use Psr\Container\ContainerInterface;
-
-return (function () {
-    /** @var ContainerInterface $container */
-    $container = include __DIR__ . '/container.php';
-    $em = $container->get(EntityManager::class);
 
+return (static function () {
+    /** @var EntityManager $em */
+    $em = include __DIR__ . '/entity-manager.php';
     return ConsoleRunner::createHelperSet($em);
 })();

config/config.php

@@ -8,7 +8,7 @@ use Laminas\ConfigAggregator;
 use Laminas\Diactoros;
 use Mezzio;
 use Mezzio\ProblemDetails;
-use Mezzio\Swoole\ConfigProvider as SwooleConfigProvider;
+use Mezzio\Swoole;
 
 use function class_exists;
 use function Shlinkio\Shlink\Common\env;
@@ -17,7 +17,7 @@ return (new ConfigAggregator\ConfigAggregator([
     Mezzio\ConfigProvider::class,
     Mezzio\Router\ConfigProvider::class,
     Mezzio\Router\FastRouteRouter\ConfigProvider::class,
-    class_exists(SwooleConfigProvider::class) ? SwooleConfigProvider::class : new ConfigAggregator\ArrayProvider([]),
+    class_exists(Swoole\ConfigProvider::class) ? Swoole\ConfigProvider::class : new ConfigAggregator\ArrayProvider([]),
     ProblemDetails\ConfigProvider::class,
     Diactoros\ConfigProvider::class,
     Common\ConfigProvider::class,
@@ -31,6 +31,7 @@ return (new ConfigAggregator\ConfigAggregator([
     new ConfigAggregator\PhpFileProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
     env('APP_ENV') === 'test'
         ? new ConfigAggregator\PhpFileProvider('config/test/*.global.php')
+        // Deprecated. When the SimplifiedConfigParser is removed, load only generated_config.php here
         : new ConfigAggregator\LaminasConfigProvider('config/params/{generated_config.php,*.config.{php,json}}'),
 ], 'data/cache/app_config.php', [
     Core\Config\SimplifiedConfigParser::class,

config/constants.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use Fig\Http\Message\StatusCodeInterface;
+
+const DEFAULT_DELETE_SHORT_URL_THRESHOLD = 15;
+const DEFAULT_SHORT_CODES_LENGTH = 5;
+const MIN_SHORT_CODES_LENGTH = 4;
+const DEFAULT_REDIRECT_STATUS_CODE = StatusCodeInterface::STATUS_FOUND;
+const DEFAULT_REDIRECT_CACHE_LIFETIME = 30;
+const LOCAL_LOCK_FACTORY = 'Shlinkio\Shlink\LocalLockFactory';
+const CUSTOM_SLUGS_REGEXP = '/[^\pL\pN._~]/u'; // Any unicode letter or number, plus ".", "_" and "~" chars
+const TITLE_TAG_VALUE = '/<title[^>]*>(.*?)<\/title>/i'; // Matches the value inside an html title tag
+const DEFAULT_QR_CODE_SIZE = 300;
+const DEFAULT_QR_CODE_MARGIN = 0;
+const DEFAULT_QR_CODE_FORMAT = 'png';
+const DEFAULT_QR_CODE_ERROR_CORRECTION = 'l';
+const MIN_TASK_WORKERS = 4;

config/container.php

@@ -5,7 +5,7 @@ declare(strict_types=1);
 use Laminas\ServiceManager\ServiceManager;
 use Symfony\Component\Lock;
 
-use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
+use const Shlinkio\Shlink\LOCAL_LOCK_FACTORY;
 
 chdir(dirname(__DIR__));
 

config/entity-manager.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Doctrine\ORM\EntityManager;
+use Psr\Container\ContainerInterface;
+
+return (static function () {
+    /** @var ContainerInterface $container */
+    $container = include __DIR__ . '/container.php';
+    return $container->get(EntityManager::class);
+})();

config/run.php

@@ -4,12 +4,11 @@ declare(strict_types=1);
 
 use Mezzio\Application;
 use Psr\Container\ContainerInterface;
-use Symfony\Component\Console\Application as CliApp;
 
-return function (bool $isCli = false): void {
+return static function (): void {
     /** @var ContainerInterface $container */
     $container = include __DIR__ . '/container.php';
-    $app = $container->get($isCli ? CliApp::class : Application::class);
+    $app = $container->get(Application::class);
 
     $app->run();
 };

config/test/bootstrap_api_tests.php

@@ -29,6 +29,6 @@ register_shutdown_function(function () use ($httpClient): void {
     );
 });
 
-$testHelper->createTestDb();
+$testHelper->createTestDb(['bin/cli', 'db:create'], ['bin/cli', 'db:migrate']);
 ApiTest\ApiTestCase::setApiClient($httpClient);
 ApiTest\ApiTestCase::setSeedFixturesCallback(fn () => $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []));

config/test/test_config.global.php

@@ -9,7 +9,8 @@ use Laminas\ConfigAggregator\ConfigAggregator;
 use Laminas\Diactoros\Response\EmptyResponse;
 use Laminas\ServiceManager\Factory\InvokableFactory;
 use Laminas\Stdlib\Glob;
-use PDO;
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger;
 use PHPUnit\Runner\Version;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\Driver\Selector;
@@ -34,30 +35,17 @@ if ($isApiTest) {
     $coverage = new CodeCoverage((new Selector())->forLineCoverage($filter), $filter);
 }
 
-$buildDbConnection = function (): array {
+$buildDbConnection = static function (): array {
     $driver = env('DB_DRIVER', 'sqlite');
     $isCi = env('CI', false);
-    $getMysqlHost = fn (string $driver) => sprintf('shlink_db%s', $driver === 'mysql' ? '' : '_maria');
-    $getCiMysqlPort = fn (string $driver) => $driver === 'mysql' ? '3307' : '3308';
+    $getMysqlHost = static fn (string $driver) => sprintf('shlink_db%s', $driver === 'mysql' ? '' : '_maria');
+    $getCiMysqlPort = static fn (string $driver) => $driver === 'mysql' ? '3307' : '3308';
 
-    $driverConfigMap = [
+    return match ($driver) {
         'sqlite' => [
             'driver' => 'pdo_sqlite',
             'path' => sys_get_temp_dir() . '/shlink-tests.db',
         ],
-        'mysql' => [
-            'driver' => 'pdo_mysql',
-            'host' => $isCi ? '127.0.0.1' : $getMysqlHost($driver),
-            'port' => $isCi ? $getCiMysqlPort($driver) : '3306',
-            'user' => 'root',
-            'password' => 'root',
-            'dbname' => 'shlink_test',
-            'charset' => 'utf8',
-            'driverOptions' => [
-                PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
-                PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true,
-            ],
-        ],
         'postgres' => [
             'driver' => 'pdo_pgsql',
             'host' => $isCi ? '127.0.0.1' : 'shlink_db_postgres',
@@ -74,12 +62,30 @@ $buildDbConnection = function (): array {
             'password' => 'Passw0rd!',
             'dbname' => 'shlink_test',
         ],
-    ];
-    $driverConfigMap['maria'] = $driverConfigMap['mysql'];
-
-    return $driverConfigMap[$driver] ?? [];
+        default => [ // mysql and maria
+            'driver' => 'pdo_mysql',
+            'host' => $isCi ? '127.0.0.1' : $getMysqlHost($driver),
+            'port' => $isCi ? $getCiMysqlPort($driver) : '3306',
+            'user' => 'root',
+            'password' => 'root',
+            'dbname' => 'shlink_test',
+            'charset' => 'utf8',
+        ],
+    };
 };
 
+$buildTestLoggerConfig = fn (string $handlerName, string $filename) => [
+    'handlers' => [
+        $handlerName => [
+            'name' => StreamHandler::class,
+            'params' => [
+                'level' => Logger::DEBUG,
+                'stream' => sprintf('data/log/api-tests/%s', $filename),
+            ],
+        ],
+    ],
+];
+
 return [
 
     'debug' => true,
@@ -111,7 +117,7 @@ return [
             'name' => 'start_collecting_coverage',
             'path' => '/api-tests/start-coverage',
             'middleware' => middleware(static function () use (&$coverage) {
-                if ($coverage) {
+                if ($coverage) { // @phpstan-ignore-line
                     $coverage->start('API tests');
                 }
                 return new EmptyResponse();
@@ -122,7 +128,7 @@ return [
             'name' => 'dump_coverage',
             'path' => '/api-tests/stop-coverage',
             'middleware' => middleware(static function () use (&$coverage) {
-                if ($coverage) {
+                if ($coverage) { // @phpstan-ignore-line
                     $basePath = __DIR__ . '/../../build/coverage-api';
                     $coverage->stop();
                     (new PHP())->process($coverage, $basePath . '.cov');
@@ -163,4 +169,9 @@ return [
         ],
     ],
 
+    'logger' => [
+        'Shlink' => $buildTestLoggerConfig('shlink_handler', 'shlink.log'),
+        'Access' => $buildTestLoggerConfig('access_handler', 'access.log'),
+    ],
+
 ];

data/infra/examples/nginx-vhost.conf

@@ -11,7 +11,7 @@ server {
 
     location ~ \.php$ {
         fastcgi_split_path_info ^(.+\.php)(/.+)$;
-        fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
+        fastcgi_pass unix:/var/run/php/php8.0-fpm.sock;
         fastcgi_index index.php;
         include fastcgi.conf;
     }

data/infra/php.Dockerfile

@@ -1,8 +1,9 @@
-FROM php:8.0.2-fpm-alpine3.13
+FROM php:8.0.9-fpm-alpine3.14
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
-ENV APCU_VERSION 5.1.19
+ENV APCU_VERSION 5.1.20
 ENV PDO_SQLSRV_VERSION 5.9.0
+ENV MS_ODBC_SQL_VERSION 17.5.2.2
 
 RUN apk update
 
@@ -44,13 +45,13 @@ RUN mkdir -p /usr/src/php/ext/apcu \
   && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
 # Install pcov and sqlsrv driver
-RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
-    apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+    apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
     apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
     pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
     docker-php-ext-enable pdo_sqlsrv pcov && \
     apk del .phpize-deps && \
-    rm msodbcsql17_17.5.1.1-1_amd64.apk
+    rm msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk
 
 # Install composer
 COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer

data/infra/swoole.Dockerfile

@@ -1,10 +1,11 @@
-FROM php:8.0.2-alpine3.13
+FROM php:8.0.9-alpine3.14
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
-ENV APCU_VERSION 5.1.19
-ENV PDO_SQLSRV_VERSION 5.9.0
+ENV APCU_VERSION 5.1.20
 ENV INOTIFY_VERSION 3.0.0
-ENV SWOOLE_VERSION 4.6.3
+ENV SWOOLE_VERSION 4.7.1
+ENV PDO_SQLSRV_VERSION 5.9.0
+ENV MS_ODBC_SQL_VERSION 17.5.2.2
 
 RUN apk update
 
@@ -54,13 +55,13 @@ RUN mkdir -p /usr/src/php/ext/inotify \
   && rm /tmp/inotify.tar.gz
 
 # Install swoole, pcov and mssql driver
-RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
-    apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+    apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
     apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
     pecl install swoole-${SWOOLE_VERSION} pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
     docker-php-ext-enable swoole pdo_sqlsrv pcov && \
     apk del .phpize-deps && \
-    rm msodbcsql17_17.5.1.1-1_amd64.apk
+    rm msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk
 
 # Install composer
 COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer

data/migrations/Version20160819142757.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
 use Doctrine\Migrations\AbstractMigration;
@@ -18,7 +18,7 @@ class Version20160819142757 extends AbstractMigration
     private const SQLITE = 'sqlite';
 
     /**
-     * @throws DBALException
+     * @throws Exception
      * @throws SchemaException
      */
     public function up(Schema $schema): void
@@ -35,10 +35,15 @@ class Version20160819142757 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function down(Schema $schema): void
     {
-        $db = $this->connection->getDatabasePlatform()->getName();
+        $this->connection->getDatabasePlatform()->getName();
+    }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
     }
 }

data/migrations/Version20160820191203.php

@@ -73,4 +73,9 @@ class Version20160820191203 extends AbstractMigration
         $schema->dropTable('short_urls_in_tags');
         $schema->dropTable('tags');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20171021093246.php

@@ -45,4 +45,9 @@ class Version20171021093246 extends AbstractMigration
         $shortUrls->dropColumn('valid_since');
         $shortUrls->dropColumn('valid_until');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20171022064541.php

@@ -42,4 +42,9 @@ class Version20171022064541 extends AbstractMigration
 
         $shortUrls->dropColumn('max_visits');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20180801183328.php

@@ -39,4 +39,9 @@ final class Version20180801183328 extends AbstractMigration
     {
         $schema->getTable('short_urls')->getColumn('short_code')->setLength($size);
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20180913205455.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\AbstractMigration;
 use PDO;
@@ -16,15 +16,13 @@ use Shlinkio\Shlink\Common\Util\IpAddress;
  */
 final class Version20180913205455 extends AbstractMigration
 {
-    /**
-     */
     public function up(Schema $schema): void
     {
         // Nothing to create
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function postUp(Schema $schema): void
     {
@@ -59,15 +57,18 @@ final class Version20180913205455 extends AbstractMigration
 
         try {
             return (string) IpAddress::fromString($addr)->getAnonymizedCopy();
-        } catch (InvalidArgumentException $e) {
+        } catch (InvalidArgumentException) {
             return null;
         }
     }
 
-    /**
-     */
     public function down(Schema $schema): void
     {
         // Nothing to rollback
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20180915110857.php

@@ -47,4 +47,9 @@ final class Version20180915110857 extends AbstractMigration
     {
         // Nothing to run
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20181020060559.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
 use Doctrine\DBAL\Schema\Table;
@@ -42,7 +42,7 @@ final class Version20181020060559 extends AbstractMigration
 
     /**
      * @throws SchemaException
-     * @throws DBALException
+     * @throws Exception
      */
     public function postUp(Schema $schema): void
     {
@@ -65,4 +65,9 @@ final class Version20181020060559 extends AbstractMigration
     {
         // No down
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20181020065148.php

@@ -38,4 +38,9 @@ final class Version20181020065148 extends AbstractMigration
     {
         // No down
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20181110175521.php

@@ -34,4 +34,9 @@ final class Version20181110175521 extends AbstractMigration
     {
         return $schema->getTable('visits')->getColumn('user_agent');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20190824075137.php

@@ -34,4 +34,9 @@ final class Version20190824075137 extends AbstractMigration
     {
         return $schema->getTable('visits')->getColumn('referer');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20190930165521.php

@@ -52,4 +52,9 @@ final class Version20190930165521 extends AbstractMigration
         $schema->getTable('short_urls')->dropColumn('domain_id');
         $schema->dropTable('domains');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20191001201532.php

@@ -46,4 +46,9 @@ final class Version20191001201532 extends AbstractMigration
         $shortUrls->dropIndex('unique_short_code_plus_domain');
         $shortUrls->addUniqueIndex(['short_code']);
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20191020074522.php

@@ -34,4 +34,9 @@ final class Version20191020074522 extends AbstractMigration
     {
         return $schema->getTable('short_urls')->getColumn('original_url');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20200105165647.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
@@ -16,7 +16,7 @@ final class Version20200105165647 extends AbstractMigration
     private const COLUMNS = ['lat' => 'latitude', 'lon' => 'longitude'];
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function preUp(Schema $schema): void
     {
@@ -43,7 +43,7 @@ final class Version20200105165647 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function up(Schema $schema): void
     {
@@ -57,7 +57,7 @@ final class Version20200105165647 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function postUp(Schema $schema): void
     {
@@ -83,7 +83,7 @@ final class Version20200105165647 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function down(Schema $schema): void
     {
@@ -93,4 +93,9 @@ final class Version20200105165647 extends AbstractMigration
             $visitLocations->dropColumn($colName);
         }
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20200106215144.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
@@ -16,7 +16,7 @@ final class Version20200106215144 extends AbstractMigration
     private const COLUMNS = ['latitude', 'longitude'];
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function up(Schema $schema): void
     {
@@ -32,7 +32,7 @@ final class Version20200106215144 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function down(Schema $schema): void
     {
@@ -44,4 +44,9 @@ final class Version20200106215144 extends AbstractMigration
             ]);
         }
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20200110182849.php

@@ -50,4 +50,9 @@ final class Version20200110182849 extends AbstractMigration
     {
         // No need (and no way) to undo this migration
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20200323190014.php

@@ -42,4 +42,9 @@ final class Version20200323190014 extends AbstractMigration
 
         $visitLocations->dropColumn('is_empty');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20200503170404.php

@@ -24,4 +24,9 @@ final class Version20200503170404 extends AbstractMigration
         $this->skipIf(! $visits->hasIndex(self::INDEX_NAME));
         $visits->dropIndex(self::INDEX_NAME);
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20201023090929.php

@@ -41,4 +41,9 @@ final class Version20201023090929 extends AbstractMigration
         $shortUrls->dropColumn('import_original_short_code');
         $shortUrls->dropIndex('unique_imports');
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20201102113208.php

@@ -60,10 +60,7 @@ final class Version20201102113208 extends AbstractMigration
            ->execute();
     }
 
-    /**
-     * @return string|int|null
-     */
-    private function resolveOneApiKeyId(Result $result)
+    private function resolveOneApiKeyId(Result $result): string|int|null
     {
         $results = [];
         while ($row = $result->fetchAssociative()) {
@@ -86,4 +83,9 @@ final class Version20201102113208 extends AbstractMigration
         $shortUrls->removeForeignKey('FK_' . self::API_KEY_COLUMN);
         $shortUrls->dropColumn(self::API_KEY_COLUMN);
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20210102174433.php

@@ -49,4 +49,9 @@ final class Version20210102174433 extends AbstractMigration
         $schema->getTable(self::TABLE_NAME)->dropIndex('UQ_role_plus_api_key');
         $schema->dropTable(self::TABLE_NAME);
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20210118153932.php

@@ -23,4 +23,9 @@ final class Version20210118153932 extends AbstractMigration
     public function down(Schema $schema): void
     {
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

data/migrations/Version20210202181026.php

@@ -34,11 +34,8 @@ final class Version20210202181026 extends AbstractMigration
         $shortUrls->dropColumn('title_was_auto_resolved');
     }
 
-    /**
-     * @fixme Workaround for https://github.com/doctrine/migrations/issues/1104
-     */
     public function isTransactional(): bool
     {
-        return false;
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
     }
 }

data/migrations/Version20210207100807.php

@@ -41,11 +41,8 @@ final class Version20210207100807 extends AbstractMigration
         $visits->dropColumn('type');
     }
 
-    /**
-     * @fixme Workaround for https://github.com/doctrine/migrations/issues/1104
-     */
     public function isTransactional(): bool
     {
-        return false;
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
     }
 }

data/migrations/Version20210306165711.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210306165711 extends AbstractMigration
+{
+    private const TABLE = 'api_keys';
+    private const COLUMN = 'name';
+
+    public function up(Schema $schema): void
+    {
+        $apiKeys = $schema->getTable(self::TABLE);
+        $this->skipIf($apiKeys->hasColumn(self::COLUMN));
+
+        $apiKeys->addColumn(
+            self::COLUMN,
+            Types::STRING,
+            [
+                'notnull' => false,
+            ],
+        );
+    }
+
+    public function down(Schema $schema): void
+    {
+        $apiKeys = $schema->getTable(self::TABLE);
+        $this->skipIf(! $apiKeys->hasColumn(self::COLUMN));
+
+        $apiKeys->dropColumn(self::COLUMN);
+    }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
+}

data/migrations/Version20210522051601.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210522051601 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf($shortUrls->hasColumn('crawlable'));
+        $shortUrls->addColumn('crawlable', Types::BOOLEAN, ['default' => false]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf(! $shortUrls->hasColumn('crawlable'));
+        $shortUrls->dropColumn('crawlable');
+    }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
+}

data/migrations/Version20210522124633.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210522124633 extends AbstractMigration
+{
+    private const POTENTIAL_BOT_COLUMN = 'potential_bot';
+
+    public function up(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf($visits->hasColumn(self::POTENTIAL_BOT_COLUMN));
+        $visits->addColumn(self::POTENTIAL_BOT_COLUMN, Types::BOOLEAN, ['default' => false]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf(! $visits->hasColumn(self::POTENTIAL_BOT_COLUMN));
+        $visits->dropColumn(self::POTENTIAL_BOT_COLUMN);
+    }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
+}

data/migrations/Version20210720143824.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\Table;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210720143824 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        $domainsTable = $schema->getTable('domains');
+        $this->skipIf($domainsTable->hasColumn('base_url_redirect'));
+
+        $this->createRedirectColumn($domainsTable, 'base_url_redirect');
+        $this->createRedirectColumn($domainsTable, 'regular_not_found_redirect');
+        $this->createRedirectColumn($domainsTable, 'invalid_short_url_redirect');
+    }
+
+    private function createRedirectColumn(Table $table, string $columnName): void
+    {
+        $table->addColumn($columnName, Types::STRING, [
+            'notnull' => false,
+            'default' => null,
+        ]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $domainsTable = $schema->getTable('domains');
+        $this->skipIf(! $domainsTable->hasColumn('base_url_redirect'));
+
+        $domainsTable->dropColumn('base_url_redirect');
+        $domainsTable->dropColumn('regular_not_found_redirect');
+        $domainsTable->dropColumn('invalid_short_url_redirect');
+    }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
+}

data/migrations/Version20211002072605.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20211002072605 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf($shortUrls->hasColumn('forward_query'));
+        $shortUrls->addColumn('forward_query', Types::BOOLEAN, ['default' => true]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf(! $shortUrls->hasColumn('forward_query'));
+        $shortUrls->dropColumn('forward_query');
+    }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
+}

data/migrations_template.txt

@@ -18,4 +18,9 @@ final class <className> extends AbstractMigration
     {
 <down>
     }
+
+    public function isTransactional(): bool
+    {
+        return $this->connection->getDatabasePlatform()->getName() !== 'mysql';
+    }
 }

docker/README.md

@@ -11,8 +11,8 @@ It exposes a shlink instance served with [swoole](https://www.swoole.co.uk/), wh
 
 The most basic way to run Shlink's docker image is by providing these mandatory env vars.
 
-* `SHORT_DOMAIN_HOST`: The custom short domain used for this shlink instance. For example **doma.in**.
-* `SHORT_DOMAIN_SCHEMA`: Either **http** or **https**.
+* `DEFAULT_DOMAIN`: The default short domain used for this shlink instance. For example **doma.in**.
+* `USE_HTTPS`: Either **true** or **false**.
 * `GEOLITE_LICENSE_KEY`: Your GeoLite2 license key. [Learn more](https://shlink.io/documentation/geolite-license-key/) about this.
 
 To run shlink on top of a local docker service, and using an internal SQLite database, do the following:
@@ -21,8 +21,8 @@ To run shlink on top of a local docker service, and using an internal SQLite dat
 docker run \
     --name shlink \
     -p 8080:8080 \
-    -e SHORT_DOMAIN_HOST=doma.in \
-    -e SHORT_DOMAIN_SCHEMA=https \
+    -e DEFAULT_DOMAIN=doma.in \
+    -e USE_HTTPS=true \
     -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
     shlinkio/shlink:stable
 ```

docker/config/php.ini

@@ -1,3 +1,4 @@
 log_errors_max_len=0
 zend.assertions=1
 assert.exception=1
+memory_limit=256M

docker/config/shlink_in_docker.local.php

@@ -7,130 +7,8 @@ namespace Shlinkio\Shlink;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
 
-use function explode;
-use function Functional\contains;
-use function Shlinkio\Shlink\Common\env;
-
-use const Shlinkio\Shlink\Core\DEFAULT_DELETE_SHORT_URL_THRESHOLD;
-use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_CACHE_LIFETIME;
-use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_STATUS_CODE;
-use const Shlinkio\Shlink\Core\DEFAULT_SHORT_CODES_LENGTH;
-use const Shlinkio\Shlink\Core\MIN_SHORT_CODES_LENGTH;
-
-$helper = new class {
-    private const DB_DRIVERS_MAP = [
-        'mysql' => 'pdo_mysql',
-        'maria' => 'pdo_mysql',
-        'postgres' => 'pdo_pgsql',
-        'mssql' => 'pdo_sqlsrv',
-    ];
-    private const DB_PORTS_MAP = [
-        'mysql' => '3306',
-        'maria' => '3306',
-        'postgres' => '5432',
-        'mssql' => '1433',
-    ];
-
-    public function getDbConfig(): array
-    {
-        $driver = env('DB_DRIVER');
-        $isMysql = contains(['maria', 'mysql'], $driver);
-        if ($driver === null || $driver === 'sqlite') {
-            return [
-                'driver' => 'pdo_sqlite',
-                'path' => 'data/database.sqlite',
-            ];
-        }
-
-        $driverOptions = ! $isMysql ? [] : [
-            // 1002 -> PDO::MYSQL_ATTR_INIT_COMMAND
-            1002 => 'SET NAMES utf8',
-            // 1000 -> PDO::MYSQL_ATTR_USE_BUFFERED_QUERY
-            1000 => true,
-        ];
-        return [
-            'driver' => self::DB_DRIVERS_MAP[$driver],
-            'dbname' => env('DB_NAME', 'shlink'),
-            'user' => env('DB_USER'),
-            'password' => env('DB_PASSWORD'),
-            'host' => env('DB_HOST', $driver === 'postgres' ? env('DB_UNIX_SOCKET') : null),
-            'port' => env('DB_PORT', self::DB_PORTS_MAP[$driver]),
-            'driverOptions' => $driverOptions,
-            'unix_socket' => $isMysql ? env('DB_UNIX_SOCKET') : null,
-        ];
-    }
-
-    public function getNotFoundRedirectsConfig(): array
-    {
-        return [
-            'invalid_short_url' => env('INVALID_SHORT_URL_REDIRECT_TO'),
-            'regular_404' => env('REGULAR_404_REDIRECT_TO'),
-            'base_url' => env('BASE_URL_REDIRECT_TO'),
-        ];
-    }
-
-    public function getVisitsWebhooks(): array
-    {
-        $webhooks = env('VISITS_WEBHOOKS');
-        return $webhooks === null ? [] : explode(',', $webhooks);
-    }
-
-    public function getRedisConfig(): ?array
-    {
-        $redisServers = env('REDIS_SERVERS');
-        return $redisServers === null ? null : ['servers' => $redisServers];
-    }
-
-    public function getDefaultShortCodesLength(): int
-    {
-        $value = (int) env('DEFAULT_SHORT_CODES_LENGTH', DEFAULT_SHORT_CODES_LENGTH);
-        return $value < MIN_SHORT_CODES_LENGTH ? MIN_SHORT_CODES_LENGTH : $value;
-    }
-
-    public function getMercureConfig(): array
-    {
-        $publicUrl = env('MERCURE_PUBLIC_HUB_URL');
-
-        return [
-            'public_hub_url' => $publicUrl,
-            'internal_hub_url' => env('MERCURE_INTERNAL_HUB_URL', $publicUrl),
-            'jwt_secret' => env('MERCURE_JWT_SECRET'),
-        ];
-    }
-};
-
 return [
 
-    'app_options' => [
-        'disable_track_param' => env('DISABLE_TRACK_PARAM'),
-    ],
-
-    'delete_short_urls' => [
-        'check_visits_threshold' => true,
-        'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', DEFAULT_DELETE_SHORT_URL_THRESHOLD),
-    ],
-
-    'entity_manager' => [
-        'connection' => $helper->getDbConfig(),
-    ],
-
-    'url_shortener' => [
-        'domain' => [
-            'schema' => env('SHORT_DOMAIN_SCHEMA', 'http'),
-            'hostname' => env('SHORT_DOMAIN_HOST', ''),
-        ],
-        'validate_url' => (bool) env('VALIDATE_URLS', false),
-        'anonymize_remote_addr' => (bool) env('ANONYMIZE_REMOTE_ADDR', true),
-        'visits_webhooks' => $helper->getVisitsWebhooks(),
-        'default_short_codes_length' => $helper->getDefaultShortCodesLength(),
-        'redirect_status_code' => (int) env('REDIRECT_STATUS_CODE', DEFAULT_REDIRECT_STATUS_CODE),
-        'redirect_cache_lifetime' => (int) env('REDIRECT_CACHE_LIFETIME', DEFAULT_REDIRECT_CACHE_LIFETIME),
-        'auto_resolve_titles' => (bool) env('AUTO_RESOLVE_TITLES', false),
-        'track_orphan_visits' => (bool) env('TRACK_ORPHAN_VISITS', true),
-    ],
-
-    'not_found_redirects' => $helper->getNotFoundRedirectsConfig(),
-
     'logger' => [
         'Shlink' => [
             'handlers' => [
@@ -145,34 +23,4 @@ return [
         ],
     ],
 
-    'dependencies' => [
-        'aliases' => env('REDIS_SERVERS') === null ? [] : [
-            'lock_store' => 'redis_lock_store',
-        ],
-    ],
-
-    'cache' => [
-        'redis' => $helper->getRedisConfig(),
-    ],
-
-    'router' => [
-        'base_path' => env('BASE_PATH', ''),
-    ],
-
-    'mezzio-swoole' => [
-        'swoole-http-server' => [
-            'port' => (int) env('PORT', 8080),
-            'options' => [
-                'worker_num' => (int) env('WEB_WORKER_NUM', 16),
-                'task_worker_num' => (int) env('TASK_WORKER_NUM', 16),
-            ],
-        ],
-    ],
-
-    'geolite2' => [
-        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'),
-    ],
-
-    'mercure' => $helper->getMercureConfig(),
-
 ];

docker/docker-entrypoint.sh

@@ -15,6 +15,21 @@ php vendor/doctrine/orm/bin/doctrine.php orm:generate-proxies -n -q
 echo "Clearing entities cache..."
 php vendor/doctrine/orm/bin/doctrine.php orm:clear-cache:metadata -n -q
 
+# Try to download GeoLite2 db file only if the license key env var was defined
+if [ ! -z "${GEOLITE_LICENSE_KEY}" ]; then
+  echo "Downloading GeoLite2 db file..."
+  php bin/cli visit:download-db -n -q
+fi
+
+# Periodicaly run visit:locate every hour
+# https://shlink.io/documentation/long-running-tasks/#locate-visits
+# set env var "ENABLE_PERIODIC_VISIT_LOCATE=true" to enable
+if [ $ENABLE_PERIODIC_VISIT_LOCATE ]; then
+  echo "Configuring periodic visit locate..."
+  echo "0 * * * * php /etc/shlink/bin/cli visit:locate -q" > /etc/crontabs/root
+  /usr/sbin/crond &
+fi
+
 # When restarting the container, swoole might think it is already in execution
 # This forces the app to be started every second until the exit code is 0
 until php vendor/bin/laminas mezzio:swoole:start; do sleep 1 ; done

docs/adr/2021-08-05-migrate-to-a-new-caching-library.md

@@ -0,0 +1,59 @@
+# Migrate to a new caching library
+
+* Status: Accepted
+* Date: 2021-08-05
+
+## Context and problem statement
+
+Shlink has always used the `doctrine/cache` library to handle anything related with cache.
+
+It was convenient, as it provided several adapters, and it was the library used by other doctrine packages.
+
+However, after the creation of the caching PSRs ([PSR-6 - Cache](https://www.php-fig.org/psr/psr-6) and [PSR-16 - Simple cache](https://www.php-fig.org/psr/psr-16)), most library authors have moved to those interfaces, and the doctrine team has decided to recommend using any other existing package and decommission their own solution.
+
+Also, Shlink needs support for Redis clusters and Redis sentinels, which is not supported by `doctrine/cache` Redis adapters.
+
+## Considered option
+
+After some research, the only packages that seem to support the capabilities required by Shlink and also seem healthy, are these:
+
+* [Symfony cache](https://symfony.com/doc/current/components/cache.html)
+    * 🟢 PSR-6 compliant: **yes**
+    * 🟢 PSR-16 compliant: **yes**
+    * 🟢 APCu support: **yes**
+    * 🟢 Redis support: **yes**
+    * 🟢 Redis cluster support: **yes**
+    * 🟢 Redis sentinel support: **yes**
+    * 🟢 Can use redis through Predis: **yes**
+    * 🔴 Individual packages per adapter: **no**
+* [Laminas cache](https://docs.laminas.dev/laminas-cache/)
+    * 🟢 PSR-6 compliant: **yes**
+    * 🟢 PSR-16 compliant: **yes**
+    * 🟢 APCu support: **yes**
+    * 🟢 Redis support: **yes**
+    * 🟢 Redis cluster support: **yes**
+    * 🔴 Redis sentinel support: **no**
+    * 🔴 Can use redis through Predis: **no**
+    * 🟢 Individual packages per adapter: **yes**
+
+## Decision outcome
+
+Even though Symfony packs all their adapters in a single component, which means we will install some code that will never be used, Laminas relies on the native redis extension for anything related with redis.
+
+That would make Shlink more complex to install, so it seems Symfony's package is the option where it's easier to migrate to.
+
+Also, it's important that the cache component can share the Redis integration (through `Predis`, in this case), as it's also used by other components (the lock component, to name one).
+
+## Pros and Cons of the Options
+
+### Symfony cache
+
+* Good because it supports Redis Sentinel.
+* Good because it allows using a external `Predis` instance.
+* Bad because it packs all the adapters in a single component.
+
+### Laminas cache
+
+* Good because allows installing only the adapters you are going to use, through separated packages.
+* Bad because it requires the php-redis native extension in order to interact with Redis.
+* Bad because it does ot seem to support Redis Sentinels.

docs/adr/README.md

@@ -2,5 +2,6 @@
 
 Here listed you will find the different architectural decisions taken in the project, including all the reasoning behind it, options considered, and final outcome.
 
+* [2021-08-05 Migrate to a new caching library](2021-08-05-migrate-to-a-new-caching-library.md)
 * [2021-02-07 Track visits to 'base_url', 'invalid_short_url' and 'regular_404'](2021-02-07-track-visits-to-base-url-invalid-short-url-and-regular-404.md)
 * [2021-01-17 Support restrictions and permissions in API keys](2021-01-17-support-restrictions-and-permissions-in-api-keys.md)

docs/async-api/async-api.json

@@ -116,6 +116,15 @@
                     "domain": {
                         "type": "string",
                         "description": "The domain in which the short URL was created. Null if it belongs to default domain."
+                    },
+                    "title": {
+                        "type": "string",
+                        "nullable": true,
+                        "description": "A descriptive title of the short URL."
+                    },
+                    "crawlable": {
+                        "type": "boolean",
+                        "description": "Tells if this URL will be included as 'Allow' in Shlink's robots.txt."
                     }
                 },
                 "example": {
@@ -133,7 +142,9 @@
                         "validUntil": null,
                         "maxVisits": 100
                     },
-                    "domain": "example.com"
+                    "domain": "example.com",
+                    "title": "The title",
+                    "crawlable": false
                 }
             },
             "ShortUrlMeta": {
@@ -179,6 +190,10 @@
                     },
                     "visitLocation": {
                         "$ref": "#/components/schemas/VisitLocation"
+                    },
+                    "potentialBot": {
+                        "type": "boolean",
+                        "description": "Tells if Shlink thinks this visit comes potentially from a bot or crawler"
                     }
                 },
                 "example": {
@@ -193,7 +208,8 @@
                         "longitude": -122.0946,
                         "regionName": "California",
                         "timezone": "America/Los_Angeles"
-                    }
+                    },
+                    "potentialBot": false
                 }
             },
             "OrphanVisit": {
@@ -232,6 +248,7 @@
                         "regionName": "California",
                         "timezone": "America/Los_Angeles"
                     },
+                    "potentialBot": false,
                     "visitedUrl": "https://doma.in",
                     "type": "base_url"
                 }

docs/swagger/definitions/NotFoundRedirects.json

@@ -0,0 +1,20 @@
+{
+    "type": "object",
+    "properties": {
+        "baseUrlRedirect": {
+            "type": "string",
+            "nullable": true,
+            "description": "URL to redirect to when a user hits the domain's base URL"
+        },
+        "regular404Redirect": {
+            "type": "string",
+            "nullable": true,
+            "description": "URL to redirect to when a user hits a not found URL other than an invalid short URL"
+        },
+        "invalidShortUrlRedirect": {
+            "type": "string",
+            "nullable": true,
+            "description": "URL to redirect to when a user hits an invalid short URL"
+        }
+    }
+}

docs/swagger/definitions/ShortUrl.json

@@ -1,5 +1,18 @@
 {
     "type": "object",
+    "required": [
+        "shortCode",
+        "shortUrl",
+        "longUrl",
+        "dateCreated",
+        "visitsCount",
+        "tags",
+        "meta",
+        "domain",
+        "title",
+        "crawlable",
+        "forwardQuery"
+    ],
     "properties": {
         "shortCode": {
             "type": "string",
@@ -41,6 +54,14 @@
             "type": "string",
             "nullable": true,
             "description": "A descriptive title of the short URL."
+        },
+        "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)."
         }
     }
 }

docs/swagger/definitions/ShortUrlEdition.json

@@ -0,0 +1,48 @@
+{
+    "type": "object",
+    "properties": {
+        "longUrl": {
+            "description": "The long URL this short URL will redirect to",
+            "type": "string"
+        },
+        "validSince": {
+            "description": "The date (in ISO-8601 format) from which this short code will be valid",
+            "type": "string",
+            "nullable": true
+        },
+        "validUntil": {
+            "description": "The date (in ISO-8601 format) until which this short code will be valid",
+            "type": "string",
+            "nullable": true
+        },
+        "maxVisits": {
+            "description": "The maximum number of allowed visits for this short code",
+            "type": "number",
+            "nullable": true
+        },
+        "validateUrl": {
+            "description": "Tells if the long URL (if provided) should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
+            "type": "boolean"
+        },
+        "tags": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "The list of tags to set to the short URL."
+        },
+        "title": {
+            "type": "string",
+            "description": "A descriptive title of the short URL.",
+            "nullable": true
+        },
+        "crawlable": {
+            "type": "boolean",
+            "description": "Tells if this URL will be included as 'Allow' in Shlink's robots.txt."
+        },
+        "forwardQuery": {
+            "type": "boolean",
+            "description": "Tells if the query params should be forwarded from the short URL to the long one, as explained in [the docs](https://shlink.io/documentation/some-features/#query-params-forwarding)."
+        }
+    }
+}

docs/swagger/definitions/Visit.json

@@ -17,6 +17,10 @@
         },
         "visitLocation": {
             "$ref": "./VisitLocation.json"
+        },
+        "potentialBot": {
+            "type": "boolean",
+            "description": "Tells if Shlink thinks this visit comes potentially from a bot or crawler"
         }
     }
 }

docs/swagger/paths/v1_short-urls.json

@@ -140,7 +140,8 @@
                                         "maxVisits": 100
                                     },
                                     "domain": null,
-                                    "title": "Welcome to Steam"
+                                    "title": "Welcome to Steam",
+                                    "crawlable": false
                                 },
                                 {
                                     "shortCode": "12Kb3",
@@ -157,7 +158,8 @@
                                         "maxVisits": null
                                     },
                                     "domain":  null,
-                                    "title": null
+                                    "title": null,
+                                    "crawlable": false
                                 },
                                 {
                                     "shortCode": "123bA",
@@ -172,7 +174,8 @@
                                         "maxVisits": null
                                     },
                                     "domain":  "example.com",
-                                    "title": null
+                                    "title": null,
+                                    "crawlable": false
                                 }
                             ],
                             "pagination": {
@@ -222,59 +225,37 @@
             "content": {
                 "application/json": {
                     "schema": {
-                        "type": "object",
-                        "required": [
-                            "longUrl"
-                        ],
-                        "properties": {
-                            "longUrl": {
-                                "description": "The URL to parse",
-                                "type": "string"
+                        "allOf": [
+                            {
+                                "$ref": "../definitions/ShortUrlEdition.json"
                             },
-                            "tags": {
-                                "description": "The URL to parse",
-                                "type": "array",
-                                "items": {
-                                    "type": "string"
+                            {
+                                "type": "object",
+                                "required": ["longUrl"],
+                                "properties": {
+                                    "customSlug": {
+                                        "description": "A unique custom slug to be used instead of the generated short code",
+                                        "type": "string"
+                                    },
+                                    "findIfExists": {
+                                        "description": "Will force existing matching URL to be returned if found, instead of creating a new one",
+                                        "type": "boolean"
+                                    },
+                                    "domain": {
+                                        "description": "The domain to which the short URL will be attached",
+                                        "type": "string"
+                                    },
+                                    "shortCodeLength": {
+                                        "description": "The length for generated short code. It has to be at least 4 and defaults to 5. It will be ignored when customSlug is provided",
+                                        "type": "number"
+                                    },
+                                    "validateUrl": {
+                                        "description": "Tells if the long URL should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
+                                        "type": "boolean"
+                                    }
                                 }
-                            },
-                            "validSince": {
-                                "description": "The date (in ISO-8601 format) from which this short code will be valid",
-                                "type": "string"
-                            },
-                            "validUntil": {
-                                "description": "The date (in ISO-8601 format) until which this short code will be valid",
-                                "type": "string"
-                            },
-                            "customSlug": {
-                                "description": "A unique custom slug to be used instead of the generated short code",
-                                "type": "string"
-                            },
-                            "maxVisits": {
-                                "description": "The maximum number of allowed visits for this short code",
-                                "type": "number"
-                            },
-                            "findIfExists": {
-                                "description": "Will force existing matching URL to be returned if found, instead of creating a new one",
-                                "type": "boolean"
-                            },
-                            "domain": {
-                                "description": "The domain to which the short URL will be attached",
-                                "type": "string"
-                            },
-                            "shortCodeLength": {
-                                "description": "The length for generated short code. It has to be at least 4 and defaults to 5. It will be ignored when customSlug is provided",
-                                "type": "number"
-                            },
-                            "validateUrl": {
-                                "description": "Tells if the long URL should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
-                                "type": "boolean"
-                            },
-                            "title": {
-                                "type": "string",
-                                "description": "A descriptive title of the short URL."
                             }
-                        }
+                        ]
                     }
                 }
             }
@@ -305,7 +286,9 @@
                             "validUntil": null,
                             "maxVisits": 500
                         },
-                        "domain": null
+                        "domain": null,
+                        "title": null,
+                        "crawlable": false
                     }
                 }
             },

docs/swagger/paths/v1_short-urls_shorten.json

@@ -74,7 +74,8 @@
                             "maxVisits": 100
                         },
                         "domain": null,
-                        "title": null
+                        "title": null,
+                        "crawlable": false
                     },
                     "text/plain": "https://doma.in/abc123"
                 }

docs/swagger/paths/v1_short-urls_{shortCode}.json

@@ -54,7 +54,8 @@
                             "maxVisits": 100
                         },
                         "domain": null,
-                        "title": null
+                        "title": null,
+                        "crawlable": false
                     }
                 }
             },
@@ -111,44 +112,7 @@
             "content": {
                 "application/json": {
                     "schema": {
-                        "type": "object",
-                        "properties": {
-                            "longUrl": {
-                                "description": "The long URL this short URL will redirect to",
-                                "type": "string"
-                            },
-                            "validSince": {
-                                "description": "The date (in ISO-8601 format) from which this short code will be valid",
-                                "type": "string",
-                                "nullable": true
-                            },
-                            "validUntil": {
-                                "description": "The date (in ISO-8601 format) until which this short code will be valid",
-                                "type": "string",
-                                "nullable": true
-                            },
-                            "maxVisits": {
-                                "description": "The maximum number of allowed visits for this short code",
-                                "type": "number",
-                                "nullable": true
-                            },
-                            "validateUrl": {
-                                "description": "Tells if the long URL (if provided) should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
-                                "type": "boolean"
-                            },
-                            "tags": {
-                                "type": "array",
-                                "items": {
-                                    "type": "string"
-                                },
-                                "description": "The list of tags to set to the short URL."
-                            },
-                            "title": {
-                                "type": "string",
-                                "description": "A descriptive title of the short URL.",
-                                "nullable": true
-                            }
-                        }
+                        "$ref": "../definitions/ShortUrlEdition.json"
                     }
                 }
             }
@@ -184,7 +148,8 @@
                             "maxVisits": 100
                         },
                         "domain": null,
-                        "title": "Shlink - The URL shortener"
+                        "title": "Shlink - The URL shortener",
+                        "crawlable": false
                     }
                 }
             },

docs/swagger/paths/v1_short-urls_{shortCode}_visits.json

@@ -57,6 +57,16 @@
                 "schema": {
                     "type": "number"
                 }
+            },
+            {
+                "name": "excludeBots",
+                "in": "query",
+                "description": "Tells if visits from potential bots should be excluded from the result set",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": ["true"]
+                }
             }
         ],
         "security": [
@@ -98,7 +108,8 @@
                                     "referer": "https://twitter.com",
                                     "date": "2015-08-20T05:05:03+04:00",
                                     "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
-                                    "visitLocation": null
+                                    "visitLocation": null,
+                                    "potentialBot": false
                                 },
                                 {
                                     "referer": "https://t.co",
@@ -112,13 +123,15 @@
                                         "longitude": -122.0946,
                                         "regionName": "California",
                                         "timezone": "America/Los_Angeles"
-                                    }
+                                    },
+                                    "potentialBot": false
                                 },
                                 {
                                     "referer": null,
                                     "date": "2015-08-20T05:05:03+04:00",
                                     "userAgent": "some_web_crawler/1.4",
-                                    "visitLocation": null
+                                    "visitLocation": null,
+                                    "potentialBot": true
                                 }
                             ],
                             "pagination": {

docs/swagger/paths/v2_domains.json

@@ -18,7 +18,7 @@
         ],
         "responses": {
             "200": {
-                "description": "The list of tags",
+                "description": "The list of domains",
                 "content": {
                     "application/json": {
                         "schema": {
@@ -33,13 +33,16 @@
                                             "type": "array",
                                             "items": {
                                                 "type": "object",
-                                                "required": ["domain", "isDefault"],
+                                                "required": ["domain", "isDefault", "redirects"],
                                                 "properties": {
                                                     "domain":  {
                                                         "type": "string"
                                                     },
                                                     "isDefault": {
                                                         "type": "boolean"
+                                                    },
+                                                    "redirects": {
+                                                        "$ref": "../definitions/NotFoundRedirects.json"
                                                     }
                                                 }
                                             }
@@ -56,15 +59,30 @@
                             "data": [
                                 {
                                     "domain": "example.com",
-                                    "isDefault": true
+                                    "isDefault": true,
+                                    "redirects": {
+                                        "baseUrlRedirect": "https://example.com/my-landing-page",
+                                        "regular404Redirect": null,
+                                        "invalidShortUrlRedirect": "https://example.com/invalid-url"
+                                    }
                                 },
                                 {
                                     "domain": "aaa.com",
-                                    "isDefault": false
+                                    "isDefault": false,
+                                    "redirects":  {
+                                        "baseUrlRedirect": null,
+                                        "regular404Redirect": null,
+                                        "invalidShortUrlRedirect": null
+                                    }
                                 },
                                 {
                                     "domain": "bbb.com",
-                                    "isDefault": false
+                                    "isDefault": false,
+                                    "redirects":  {
+                                        "baseUrlRedirect": null,
+                                        "regular404Redirect": null,
+                                        "invalidShortUrlRedirect": "https://example.com/invalid-url"
+                                    }
                                 }
                             ]
                         }

docs/swagger/paths/v2_domains_redirects.json

@@ -0,0 +1,124 @@
+{
+    "patch": {
+        "operationId": "setDomainRedirects",
+        "tags": [
+            "Domains"
+        ],
+        "summary": "Sets domain \"not found\" redirects",
+        "description": "Sets the URLs that you want a visitor to get redirected to for \"not found\" URLs for a specific domain",
+        "security": [
+            {
+                "ApiKey": []
+            }
+        ],
+        "parameters": [
+            {
+                "$ref": "../parameters/version.json"
+            }
+        ],
+        "requestBody": {
+            "description": "Request body.",
+            "required": true,
+            "content": {
+                "application/json": {
+                    "schema": {
+                        "type": "object",
+                        "allOf": [
+                            {
+                                "required": ["domain"],
+                                "properties": {
+                                    "domain": {
+                                        "description": "The domain's authority for which you want to set redirects",
+                                        "type": "string"
+                                    }
+                                }
+                            },
+                            {
+                                "$ref": "../definitions/NotFoundRedirects.json"
+                            }
+                        ]
+                    }
+                }
+            }
+        },
+        "responses": {
+            "200": {
+                "description": "The domain's redirects after the update, when existing redirects have been merged with provided ones.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "allOf": [
+                                {
+                                    "required": ["baseUrlRedirect", "regular404Redirect", "invalidShortUrlRedirect"]
+                                },
+                                {
+                                    "$ref": "../definitions/NotFoundRedirects.json"
+                                }
+                            ]
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "baseUrlRedirect": "https://example.com/my-landing-page",
+                        "regular404Redirect": null,
+                        "invalidShortUrlRedirect": "https://example.com/invalid-url"
+                    }
+                }
+            },
+            "400": {
+                "description": "Provided data is invalid.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "type": "object",
+                            "allOf": [
+                                {
+                                    "$ref": "../definitions/Error.json"
+                                },
+                                {
+                                    "type": "object",
+                                    "required": ["invalidElements"],
+                                    "properties": {
+                                        "invalidElements": {
+                                            "type": "array",
+                                            "items": {
+                                                "type": "string",
+                                                "enum": [
+                                                    "domain",
+                                                    "baseUrlRedirect",
+                                                    "regular404Redirect",
+                                                    "invalidShortUrlRedirect"
+                                                ]
+                                            }
+                                        }
+                                    }
+                                }
+                            ]
+                        }
+                    }
+                }
+            },
+            "403": {
+                "description": "Default domain was provided, and it cannot be edited this way.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/v2_tags_{tag}_visits.json

@@ -54,6 +54,16 @@
                 "schema": {
                     "type": "number"
                 }
+            },
+            {
+                "name": "excludeBots",
+                "in": "query",
+                "description": "Tells if visits from potential bots should be excluded from the result set",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": ["true"]
+                }
             }
         ],
         "security": [
@@ -95,7 +105,8 @@
                                     "referer": "https://twitter.com",
                                     "date": "2015-08-20T05:05:03+04:00",
                                     "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
-                                    "visitLocation": null
+                                    "visitLocation": null,
+                                    "potentialBot": false
                                 },
                                 {
                                     "referer": "https://t.co",
@@ -109,13 +120,15 @@
                                         "longitude": -122.0946,
                                         "regionName": "California",
                                         "timezone": "America/Los_Angeles"
-                                    }
+                                    },
+                                    "potentialBot": false
                                 },
                                 {
                                     "referer": null,
                                     "date": "2015-08-20T05:05:03+04:00",
                                     "userAgent": "some_web_crawler/1.4",
-                                    "visitLocation": null
+                                    "visitLocation": null,
+                                    "potentialBot": true
                                 }
                             ],
                             "pagination": {

docs/swagger/paths/v2_visits_orphan.json

@@ -45,6 +45,16 @@
                 "schema": {
                     "type": "number"
                 }
+            },
+            {
+                "name": "excludeBots",
+                "in": "query",
+                "description": "Tells if visits from potential bots should be excluded from the result set",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": ["true"]
+                }
             }
         ],
         "security": [
@@ -87,6 +97,7 @@
                                     "date": "2015-08-20T05:05:03+04:00",
                                     "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
                                     "visitLocation": null,
+                                    "potentialBot": false,
                                     "visitedUrl": "https://doma.in",
                                     "type": "base_url"
                                 },
@@ -103,6 +114,7 @@
                                         "regionName": "California",
                                         "timezone": "America/Los_Angeles"
                                     },
+                                    "potentialBot": false,
                                     "visitedUrl": "https://doma.in/foo",
                                     "type": "invalid_short_url"
                                 },
@@ -111,6 +123,7 @@
                                     "date": "2015-08-20T05:05:03+04:00",
                                     "userAgent": "some_web_crawler/1.4",
                                     "visitLocation": null,
+                                    "potentialBot": true,
                                     "visitedUrl": "https://doma.in/foo/bar/baz",
                                     "type": "regular_404"
                                 }

docs/swagger/paths/{shortCode}_qr-code.json

@@ -5,7 +5,7 @@
             "URL Shortener"
         ],
         "summary": "Short URL QR code",
-        "description": "Generates a QR code image pointing to a short URL",
+        "description": "Generates a QR code image pointing to a short URL.<br />Since this is not an API endpoint but an image one, when an invalid value is provided for any of the query params, they will fall to their default values instead of throwing an error.",
         "parameters": [
             {
                 "name": "shortCode",
@@ -35,10 +35,8 @@
                 "required": false,
                 "schema": {
                     "type": "string",
-                    "enum": [
-                        "png",
-                        "svg"
-                    ]
+                    "enum": ["png", "svg"],
+                    "default": "png"
                 }
             },
             {
@@ -51,6 +49,17 @@
                     "minimum": 0,
                     "default": 0
                 }
+            },
+            {
+                "name": "errorCorrection",
+                "in": "query",
+                "description": "The error correction level to apply to the the QR code: **[L]**ow, **[M]**edium, **[Q]**uartile or **[H]**igh. See [docs](https://www.qrcode.com/en/about/error_correction.html).",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": ["L", "M", "Q", "H"],
+                    "default": "L"
+                }
             }
         ],
         "responses": {

docs/swagger/swagger.json

@@ -1,5 +1,5 @@
 {
-    "openapi": "3.0.0",
+    "openapi": "3.0.3",
     "info": {
         "title": "Shlink",
         "description": "Shlink, the self-hosted URL shortener",
@@ -102,6 +102,9 @@
         "/rest/v{version}/domains": {
             "$ref": "paths/v2_domains.json"
         },
+        "/rest/v{version}/domains/redirects": {
+            "$ref": "paths/v2_domains_redirects.json"
+        },
 
         "/rest/v{version}/mercure-info": {
             "$ref": "paths/v2_mercure-info.json"

module/CLI/config/cli.config.php

@@ -15,6 +15,7 @@ return [
             Command\ShortUrl\DeleteShortUrlCommand::NAME => Command\ShortUrl\DeleteShortUrlCommand::class,
 
             Command\Visit\LocateVisitsCommand::NAME => Command\Visit\LocateVisitsCommand::class,
+            Command\Visit\DownloadGeoLiteDbCommand::NAME => Command\Visit\DownloadGeoLiteDbCommand::class,
 
             Command\Api\GenerateKeyCommand::NAME => Command\Api\GenerateKeyCommand::class,
             Command\Api\DisableKeyCommand::NAME => Command\Api\DisableKeyCommand::class,
@@ -26,6 +27,7 @@ return [
             Command\Tag\DeleteTagsCommand::NAME => Command\Tag\DeleteTagsCommand::class,
 
             Command\Domain\ListDomainsCommand::NAME => Command\Domain\ListDomainsCommand::class,
+            Command\Domain\DomainRedirectsCommand::NAME => Command\Domain\DomainRedirectsCommand::class,
 
             Command\Db\CreateDatabaseCommand::NAME => Command\Db\CreateDatabaseCommand::class,
             Command\Db\MigrateDatabaseCommand::NAME => Command\Db\MigrateDatabaseCommand::class,

module/CLI/config/dependencies.config.php

@@ -10,6 +10,7 @@ use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Laminas\ServiceManager\Factory\InvokableFactory;
 use Shlinkio\Shlink\Common\Doctrine\NoDbNameConnectionFactory;
 use Shlinkio\Shlink\Core\Domain\DomainService;
+use Shlinkio\Shlink\Core\Options\TrackingOptions;
 use Shlinkio\Shlink\Core\Service;
 use Shlinkio\Shlink\Core\ShortUrl\Helper\ShortUrlStringifier;
 use Shlinkio\Shlink\Core\ShortUrl\Transformer\ShortUrlDataTransformer;
@@ -23,7 +24,7 @@ use Symfony\Component\Console as SymfonyCli;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Process\PhpExecutableFinder;
 
-use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
+use const Shlinkio\Shlink\LOCAL_LOCK_FACTORY;
 
 return [
 
@@ -44,6 +45,7 @@ return [
             Command\ShortUrl\GetVisitsCommand::class => ConfigAbstractFactory::class,
             Command\ShortUrl\DeleteShortUrlCommand::class => ConfigAbstractFactory::class,
 
+            Command\Visit\DownloadGeoLiteDbCommand::class => ConfigAbstractFactory::class,
             Command\Visit\LocateVisitsCommand::class => ConfigAbstractFactory::class,
 
             Command\Api\GenerateKeyCommand::class => ConfigAbstractFactory::class,
@@ -59,11 +61,17 @@ return [
             Command\Db\MigrateDatabaseCommand::class => ConfigAbstractFactory::class,
 
             Command\Domain\ListDomainsCommand::class => ConfigAbstractFactory::class,
+            Command\Domain\DomainRedirectsCommand::class => ConfigAbstractFactory::class,
         ],
     ],
 
     ConfigAbstractFactory::class => [
-        Util\GeolocationDbUpdater::class => [DbUpdater::class, Reader::class, LOCAL_LOCK_FACTORY],
+        Util\GeolocationDbUpdater::class => [
+            DbUpdater::class,
+            Reader::class,
+            LOCAL_LOCK_FACTORY,
+            TrackingOptions::class,
+        ],
         Util\ProcessRunner::class => [SymfonyCli\Helper\ProcessHelper::class],
         ApiKey\RoleResolver::class => [DomainService::class],
 
@@ -80,11 +88,11 @@ return [
         Command\ShortUrl\GetVisitsCommand::class => [Visit\VisitsStatsHelper::class],
         Command\ShortUrl\DeleteShortUrlCommand::class => [Service\ShortUrl\DeleteShortUrlService::class],
 
+        Command\Visit\DownloadGeoLiteDbCommand::class => [Util\GeolocationDbUpdater::class],
         Command\Visit\LocateVisitsCommand::class => [
             Visit\VisitLocator::class,
             IpLocationResolverInterface::class,
             LockFactory::class,
-            Util\GeolocationDbUpdater::class,
         ],
 
         Command\Api\GenerateKeyCommand::class => [ApiKeyService::class, ApiKey\RoleResolver::class],
@@ -97,6 +105,7 @@ return [
         Command\Tag\DeleteTagsCommand::class => [TagService::class],
 
         Command\Domain\ListDomainsCommand::class => [DomainService::class],
+        Command\Domain\DomainRedirectsCommand::class => [DomainService::class],
 
         Command\Db\CreateDatabaseCommand::class => [
             LockFactory::class,

module/CLI/src/ApiKey/RoleResolver.php

@@ -8,13 +8,12 @@ use Shlinkio\Shlink\Core\Domain\DomainServiceInterface;
 use Shlinkio\Shlink\Rest\ApiKey\Model\RoleDefinition;
 use Symfony\Component\Console\Input\InputInterface;
 
+use function is_string;
+
 class RoleResolver implements RoleResolverInterface
 {
-    private DomainServiceInterface $domainService;
-
-    public function __construct(DomainServiceInterface $domainService)
+    public function __construct(private DomainServiceInterface $domainService)
     {
-        $this->domainService = $domainService;
     }
 
     public function determineRoles(InputInterface $input): array
@@ -26,7 +25,7 @@ class RoleResolver implements RoleResolverInterface
         if ($author) {
             $roleDefinitions[] = RoleDefinition::forAuthoredShortUrls();
         }
-        if ($domainAuthority !== null) {
+        if (is_string($domainAuthority)) {
             $domain = $this->domainService->getOrCreate($domainAuthority);
             $roleDefinitions[] = RoleDefinition::forDomain($domain);
         }

module/CLI/src/Command/Api/DisableKeyCommand.php

@@ -19,12 +19,9 @@ class DisableKeyCommand extends Command
 {
     public const NAME = 'api-key:disable';
 
-    private ApiKeyServiceInterface $apiKeyService;
-
-    public function __construct(ApiKeyServiceInterface $apiKeyService)
+    public function __construct(private ApiKeyServiceInterface $apiKeyService)
     {
         parent::__construct();
-        $this->apiKeyService = $apiKeyService;
     }
 
     protected function configure(): void

module/CLI/src/Command/Api/GenerateKeyCommand.php

@@ -23,14 +23,11 @@ class GenerateKeyCommand extends BaseCommand
 {
     public const NAME = 'api-key:generate';
 
-    private ApiKeyServiceInterface $apiKeyService;
-    private RoleResolverInterface $roleResolver;
-
-    public function __construct(ApiKeyServiceInterface $apiKeyService, RoleResolverInterface $roleResolver)
-    {
+    public function __construct(
+        private ApiKeyServiceInterface $apiKeyService,
+        private RoleResolverInterface $roleResolver,
+    ) {
         parent::__construct();
-        $this->apiKeyService = $apiKeyService;
-        $this->roleResolver = $roleResolver;
     }
 
     protected function configure(): void
@@ -42,6 +39,10 @@ class GenerateKeyCommand extends BaseCommand
 
             <info>%command.full_name%</info>
 
+        You can optionally set its name for tracking purposes with <comment>--name</comment> or <comment>-m</comment>:
+
+            <info>%command.full_name% --name Alice</info>
+
         You can optionally set its expiration date with <comment>--expiration-date</comment> or <comment>-e</comment>:
 
             <info>%command.full_name% --expiration-date 2020-01-01</info>
@@ -56,6 +57,12 @@ class GenerateKeyCommand extends BaseCommand
         $this
             ->setName(self::NAME)
             ->setDescription('Generates a new valid API key.')
+            ->addOption(
+                'name',
+                'm',
+                InputOption::VALUE_REQUIRED,
+                'The name by which this API key will be known.',
+            )
             ->addOptionWithDeprecatedFallback(
                 'expiration-date',
                 'e',
@@ -82,6 +89,7 @@ class GenerateKeyCommand extends BaseCommand
         $expirationDate = $this->getOptionWithDeprecatedFallback($input, 'expiration-date');
         $apiKey = $this->apiKeyService->create(
             isset($expirationDate) ? Chronos::parse($expirationDate) : null,
+            $input->getOption('name'),
             ...$this->roleResolver->determineRoles($input),
         );
 
@@ -89,7 +97,7 @@ class GenerateKeyCommand extends BaseCommand
         $io->success(sprintf('Generated API key: "%s"', $apiKey->toString()));
 
         if (! $apiKey->isAdmin()) {
-            ShlinkTable::fromOutput($io)->render(
+            ShlinkTable::default($io)->render(
                 ['Role name', 'Role metadata'],
                 $apiKey->mapRoles(fn (string $name, array $meta) => [$name, arrayToString($meta, 0)]),
                 null,

module/CLI/src/Command/Api/ListKeysCommand.php

@@ -27,12 +27,9 @@ class ListKeysCommand extends BaseCommand
 
     public const NAME = 'api-key:list';
 
-    private ApiKeyServiceInterface $apiKeyService;
-
-    public function __construct(ApiKeyServiceInterface $apiKeyService)
+    public function __construct(private ApiKeyServiceInterface $apiKeyService)
     {
         parent::__construct();
-        $this->apiKeyService = $apiKeyService;
     }
 
     protected function configure(): void
@@ -57,11 +54,11 @@ class ListKeysCommand extends BaseCommand
             $messagePattern = $this->determineMessagePattern($apiKey);
 
             // Set columns for this row
-            $rowData = [sprintf($messagePattern, $apiKey)];
+            $rowData = [sprintf($messagePattern, $apiKey), sprintf($messagePattern, $apiKey->name() ?? '-')];
             if (! $enabledOnly) {
                 $rowData[] = sprintf($messagePattern, $this->getEnabledSymbol($apiKey));
             }
-            $rowData[] = $expiration !== null ? $expiration->toAtomString() : '-';
+            $rowData[] = $expiration?->toAtomString() ?? '-';
             $rowData[] = $apiKey->isAdmin() ? 'Admin' : implode("\n", $apiKey->mapRoles(
                 fn (string $roleName, array $meta) =>
                     empty($meta)
@@ -72,12 +69,14 @@ class ListKeysCommand extends BaseCommand
             return $rowData;
         });
 
-        ShlinkTable::fromOutput($output)->render(array_filter([
+        ShlinkTable::withRowSeparators($output)->render(array_filter([
             'Key',
+            'Name',
             ! $enabledOnly ? 'Is enabled' : null,
             'Expiration date',
             'Roles',
         ]), $rows);
+
         return ExitCodes::EXIT_SUCCESS;
     }
 

module/CLI/src/Command/BaseCommand.php

@@ -12,40 +12,36 @@ use function Shlinkio\Shlink\Core\kebabCaseToCamelCase;
 use function sprintf;
 use function str_contains;
 
+/** @deprecated */
 abstract class BaseCommand extends Command
 {
     /**
-     * @param mixed|null $default
+     * @param string|string[]|bool|null $default
      */
     protected function addOptionWithDeprecatedFallback(
         string $name,
         ?string $shortcut = null,
         ?int $mode = null,
         string $description = '',
-        $default = null
+        bool|string|array|null $default = null,
     ): self {
         $this->addOption($name, $shortcut, $mode, $description, $default);
 
         if (str_contains($name, '-')) {
             $camelCaseName = kebabCaseToCamelCase($name);
-            $this->addOption($camelCaseName, null, $mode, sprintf('[DEPRECATED] Same as "%s".', $name), $default);
+            $this->addOption($camelCaseName, null, $mode, sprintf('[DEPRECATED] Alias for "%s".', $name), $default);
         }
 
         return $this;
     }
 
-    /**
-     * @return bool|string|string[]|null
-     */
-    protected function getOptionWithDeprecatedFallback(InputInterface $input, string $name)
+    // @phpstan-ignore-next-line
+    protected function getOptionWithDeprecatedFallback(InputInterface $input, string $name) // phpcs:ignore
     {
         $rawInput = method_exists($input, '__toString') ? $input->__toString() : '';
         $camelCaseName = kebabCaseToCamelCase($name);
+        $resolvedOptionName = str_contains($rawInput, $camelCaseName) ? $camelCaseName : $name;
 
-        if (str_contains($rawInput, $camelCaseName)) {
-            return $input->getOption($camelCaseName);
-        }
-
-        return $input->getOption($name);
+        return $input->getOption($resolvedOptionName);
     }
 }