Merge pull request #369 from acelaya/feature/postgres-query-error

Feature/postgres query error

.gitattributes

@@ -1,12 +1,14 @@
+/config/test export-ignore
 /data/infra export-ignore
 /docs export-ignore
 /module/CLI/test export-ignore
 /module/CLI/test-resources export-ignore
 /module/Common/test export-ignore
-/module/Common/test-func export-ignore
+/module/Common/test-db export-ignore
 /module/Core/test export-ignore
-/module/Core/test-func export-ignore
+/module/Core/test-db export-ignore
 /module/Rest/test export-ignore
+/module/Rest/test-api export-ignore
 .env.dist export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
@@ -17,9 +19,9 @@ build.sh export-ignore
 CHANGELOG.md export-ignore
 docker-compose.override.yml.dist export-ignore
 docker-compose.yml export-ignore
-func_tests_bootstrap.php export-ignore
 indocker export-ignore
 phpcs.xml export-ignore
 phpunit.xml.dist export-ignore
-phpunit-func.xml export-ignore
+phpunit-api.xml export-ignore
+phpunit-db.xml export-ignore
 phpstan.neon

.gitignore

@@ -1,8 +1,12 @@
 .idea
 build
 composer.lock
+composer.phar
 vendor/
 .env
 data/database.sqlite
-docs/swagger-ui
+data/shlink-tests.db
+data/GeoLite2-City.mmdb
+docs/swagger-ui*
 docker-compose.override.yml
+.phpunit.result.cache

.phpstorm.meta.php

@@ -2,7 +2,7 @@
 namespace PHPSTORM_META;
 
 use Psr\Container\ContainerInterface;
-use Zend\ServiceManager\ServiceManager;
+use Zend\ServiceManager\ServiceLocatorInterface;
 
 /**
  * PhpStorm Container Interop code completion
@@ -17,7 +17,7 @@ $STATIC_METHOD_TYPES = [
     ContainerInterface::get('') => [
         '' == '@',
     ],
-    ServiceManager::build('') => [
+    ServiceLocatorInterface::build('') => [
         '' == '@',
     ],
 ];

.scrutinizer.yml

@@ -1,6 +1,13 @@
 tools:
-  external_code_coverage: true
+  external_code_coverage:
+    timeout: 600
 checks:
-    php:
-        code_rating: true
-        duplication: true
+  php:
+    code_rating: true
+    duplication: true
+build:
+  nodes:
+    analysis:
+      tests:
+        override:
+          - php-scrutinizer-run

.travis.yml

@@ -7,22 +7,45 @@ branches:
 php:
   - 7.1
   - 7.2
+  - 7.3
 
 before_install:
-  - phpenv config-add data/infra/travis-php/memcached.ini
-  - phpenv config-add data/infra/travis-php/apcu.ini
+  - echo 'extension = memcached.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+  - echo 'extension = apcu.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+  - yes | pecl install swoole
+  - phpenv config-rm xdebug.ini || return 0
 
-before_script:
+install:
   - composer self-update
   - composer install --no-interaction
 
 script:
   - mkdir build
-  - composer check
+  - composer ci
 
-after_script:
-  - vendor/bin/phpcov merge build --clover build/clover.xml
+after_success:
+  - rm -f build/clover.xml
+  - phpdbg -qrr vendor/bin/phpcov merge build --clover build/clover.xml
   - wget https://scrutinizer-ci.com/ocular.phar
   - php ocular.phar code-coverage:upload --format=php-clover build/clover.xml
 
-sudo: false
+# Before deploying, build dist file for current travis tag
+before_deploy:
+  - rm -f ocular.phar
+  - ./build.sh ${TRAVIS_TAG#?}
+
+deploy:
+  - provider: releases
+    api_key:
+      secure: a9dbZchocqeuOViwUeNH54bQR5Sz7rEYXx5b9WPFtnFn9LGKKUaLbA2U91UQ9QKPrcTpsALubUYbw2CnNmvCwzaY+R8lCD3gkU4ohsEnbpnw3deOeixI74sqBHJAuCH9FSaRDGILoBMtUKx2xlzIymFxkIsgIukkGbdkWHDlRWY3oTUUuw1SQ2Xk9KDsbJQtjIc1+G/O6gHaV4qv/R9W8NPmJExKTNDrAZbC1vIUnxqp4UpVo1hst8qPd1at94CndDYM5rG+7imGbdtxTxzamt819qdTO1OfvtctKawNAm7YXZrrWft6c7gI6j6SI4hxd+ZrrPBqbaRFHkZHjnNssO/yn4SaOHFFzccmu0MzvpPCf0qWZwd3sGHVYer1MnR2mHYqU84QPlW3nrHwJjkrpq3+q0JcBY6GsJs+RskHNtkMTKV05Iz6QUI5YZGwTpuXaRm036SmavjGc4IDlMaYCk/NmbB9BKpthJxLdUpczOHpnjXXHziotWD6cfEnbjU3byfD8HY5WrxSjsNT7SKmXN3hRof7bk985ewQVjGT42O3NbnfnqjQQWr/B7/zFTpLR4f526Bkq12CdCyf5lvrbq+POkLVdJ+uFfR7ds248Ue/jBQy6kM1tWmKF9QiwisFlA84eQ4CW3I93Rp97URv+AQa9zmbD0Ve3Udp+g6nF5I=
+    file: "./build/shlink_${TRAVIS_TAG#?}_dist.zip"
+    skip_cleanup: true
+    on:
+      tags: true
+      php: 7.1
+  - provider: script
+    script: bash data/travis/trigger_docker_build.sh
+    skip_cleanup: true
+    on:
+      tags: true
+      php: 7.1

CHANGELOG.md

@@ -1,5 +1,426 @@
 # CHANGELOG
 
+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).
+
+## 1.16.2 - 2019-03-05
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* *Nothing*
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#368](https://github.com/shlinkio/shlink/issues/368) Fixed error produced when running a `SELECT COUNT(...)` with `ORDER BY` in PostgreSQL databases.
+
+
+## 1.16.1 - 2019-02-26
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* [#363](https://github.com/shlinkio/shlink/issues/363) Updated to `shlinkio/php-coding-standard` version 1.1.0
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#362](https://github.com/shlinkio/shlink/issues/362) Fixed all visits without an IP address being processed every time the `visit:process` command is executed.
+
+
+## 1.16.0 - 2019-02-23
+
+#### Added
+
+* [#304](https://github.com/shlinkio/shlink/issues/304) Added health endpoint to check healthiness of the service. Useful in container-based infrastructures.
+
+    Call [GET /rest/health] in order to get a response like this:
+
+    ```http
+    HTTP/1.1 200 OK
+    Content-Type: application/health+json
+    Content-Length: 681
+
+    {
+      "status": "pass",
+      "version": "1.16.0",
+      "links": {
+        "about": "https://shlink.io",
+        "project": "https://github.com/shlinkio/shlink"
+      }
+    }
+    ```
+
+    The status code can be `200 OK` in case of success or `503 Service Unavailable` in case of error, while the `status` property will be one of `pass` or `fail`, as defined in the [Health check RFC](https://inadarei.github.io/rfc-healthcheck/).
+
+* [#279](https://github.com/shlinkio/shlink/issues/279) Added new `findIfExists` flag to the `[POST /short-url]` REST endpoint and the `short-urls:generate` CLI command. It can be used to return existing short URLs when found, instead of creating new ones.
+
+    Thanks to this flag you won't need to remember if you created a short URL for a long one. It will just create it if needed or return the existing one if possible.
+
+    The behavior might be a little bit counterintuitive when combined with other params. This is how the endpoint behaves when providing this new flag:
+
+    * Only the long URL is provided: It will return the newest match or create a new short URL if none is found.
+    * Long url and custom slug are provided: It will return the short URL when both params match, return an error when the slug is in use for another long URL, or create a new short URL otherwise.
+    * Any of the above but including other params (tags, validSince, validUntil, maxVisits): It will behave the same as the previous two cases, but it will try to exactly match existing results using all the params. If any of them does not match, it will try to create a new short URL.
+
+* [#336](https://github.com/shlinkio/shlink/issues/336) Added an API test suite which performs API calls to an actual instance of the web service.
+
+#### Changed
+
+* [#342](https://github.com/shlinkio/shlink/issues/342) The installer no longer asks for a charset to be provided, and instead, it shuffles the base62 charset.
+* [#320](https://github.com/shlinkio/shlink/issues/320) Replaced query builder by plain DQL for all queries which do not need to be dynamically generated.
+* [#330](https://github.com/shlinkio/shlink/issues/330) No longer allow failures on PHP 7.3 envs during project CI build.
+* [#335](https://github.com/shlinkio/shlink/issues/335) Renamed functional test suite to database test suite, since that better describes what it actually does.
+* [#346](https://github.com/shlinkio/shlink/issues/346) Extracted installer as an independent tool.
+* [#261](https://github.com/shlinkio/shlink/issues/261) Increased mutation score to 70%.
+
+#### Deprecated
+
+* [#351](https://github.com/shlinkio/shlink/issues/351) Deprecated `config:generate-charset` and `config:generate-secret` CLI commands.
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#317](https://github.com/shlinkio/shlink/issues/317) Fixed error while trying to generate previews because of global config file being deleted by mistake by build script.
+* [#307](https://github.com/shlinkio/shlink/issues/307) Fixed memory leak while trying to process huge amounts of visits due to the query not being properly paginated.
+
+
+## 1.15.1 - 2018-12-16
+
+#### Added
+
+* [#162](https://github.com/shlinkio/shlink/issues/162) Added non-rest endpoints to swagger definition.
+
+#### Changed
+
+* [#312](https://github.com/shlinkio/shlink/issues/312) Now all config files both in `php` and `json` format are loaded from `config/params` folder, easing users to provided customizations to docker image.
+* [#226](https://github.com/shlinkio/shlink/issues/226) Updated how table are rendered in CLI commands, making use of new features in Symfony 4.2.
+* [#321](https://github.com/shlinkio/shlink/issues/321) Extracted entities mappings from entities to external config files.
+* [#308](https://github.com/shlinkio/shlink/issues/308) Automated docker image building.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* [#301](https://github.com/shlinkio/shlink/issues/301) Removed custom `AccessLogFactory` in favor of the implementation included in [zendframework/zend-expressive-swoole](https://github.com/zendframework/zend-expressive-swoole) v2.2.0
+
+#### Fixed
+
+* [#309](https://github.com/shlinkio/shlink/issues/309) Added missing favicon to prevent 404 errors logged when an error page is loaded in a browser.
+* [#310](https://github.com/shlinkio/shlink/issues/310) Fixed execution context not being properly detected, making `CloseDbConnectionMiddlware` to be always piped. Now the check is not even made, which simplifies everything.
+
+
+## 1.15.0 - 2018-12-02
+
+#### Added
+
+* [#208](https://github.com/shlinkio/shlink/issues/208) Added initial support to run shlink using [swoole](https://www.swoole.co.uk/), a non-blocking IO server which improves the performance of shlink from 4 to 10 times.
+
+    Run shlink with `./vendor/bin/zend-expressive-swoole start` to start-up the service, which will be exposed in port `8080`.
+
+    Adding the `-d` flag, it will be started as a background service. Then you can use the `./vendor/bin/zend-expressive-swoole stop` command in order to stop it.
+
+* [#266](https://github.com/shlinkio/shlink/issues/266) Added pagination to `GET /short-urls/{shortCode}/visits` endpoint.
+
+    In order to make it backwards compatible, it keeps returning all visits by default, but it now allows to provide the `page` and `itemsPerPage` query parameters in order to configure the number of items to get.
+
+#### Changed
+
+* [#267](https://github.com/shlinkio/shlink/issues/267) API responses and the CLI interface is no longer translated and uses english always. Only not found error templates are still translated.
+* [#289](https://github.com/shlinkio/shlink/issues/289) Extracted coding standard rules to a separated package.
+* [#273](https://github.com/shlinkio/shlink/issues/273) Improved code coverage in repository classes.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#278](https://github.com/shlinkio/shlink/pull/278) Added missing `X-Api-Key` header to the list of valid cross domain headers.
+* [#295](https://github.com/shlinkio/shlink/pull/295) Fixed custom slugs so that they are case sensitive and do not try to lowercase provided values.
+
+
+## 1.14.1 - 2018-11-17
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* [#260](https://github.com/shlinkio/shlink/issues/260) Increased mutation score to 65%.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#271](https://github.com/shlinkio/shlink/issues/271) Fixed memory leak produced when processing high amounts of visits at the same time.
+* [#272](https://github.com/shlinkio/shlink/issues/272) Fixed errors produced when trying to process visits multiple times in parallel, by using a lock which ensures only one instance is run at a time.
+
+
+## 1.14.0 - 2018-11-16
+
+#### Added
+
+* [#236](https://github.com/shlinkio/shlink/issues/236) Added option to define a redirection to a custom URL when a user hits an invalid short URL.
+
+    It only affects URLs matched as "short URL" where the short code is invalid, not any 404 that happens in the app. For example, a request to the path `/foo/bar` will keep returning a 404.
+
+    This new option will be asked by the installer both for new shlink installations and for any previous shlink version which is updated.
+
+* [#189](https://github.com/shlinkio/shlink/issues/189) and [#240](https://github.com/shlinkio/shlink/issues/240) Added new [GeoLite2](https://dev.maxmind.com/geoip/geoip2/geolite2/)-based geolocation service which is faster and more reliable than previous one.
+
+    It does not have API limit problems, since it uses a local database file.
+
+    Previous service is still used as a fallback in case GeoLite DB does not contain any IP address.
+
+#### Changed
+
+* [#241](https://github.com/shlinkio/shlink/issues/241) Fixed columns in `visit_locations` table, to be snake_case instead of camelCase.
+* [#228](https://github.com/shlinkio/shlink/issues/228) Updated how exceptions are serialized into logs, by using monlog's `PsrLogMessageProcessor`.
+* [#225](https://github.com/shlinkio/shlink/issues/225) Performance and maintainability slightly improved by enforcing via code sniffer that all global namespace classes, functions and constants are explicitly imported.
+* [#196](https://github.com/shlinkio/shlink/issues/196) Reduced anemic model in entities, defining more expressive public APIs instead.
+* [#249](https://github.com/shlinkio/shlink/issues/249) Added [functional-php](https://github.com/lstrojny/functional-php) to ease collections handling.
+* [#253](https://github.com/shlinkio/shlink/issues/253) Increased `user_agent` column length in `visits` table to 512.
+* [#256](https://github.com/shlinkio/shlink/issues/256) Updated to Infection v0.11.
+* [#202](https://github.com/shlinkio/shlink/issues/202) Added missing response examples to OpenAPI docs.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#223](https://github.com/shlinkio/shlink/issues/223) Fixed PHPStan errors produced with symfony/console 4.1.5
+
+
+## 1.13.2 - 2018-10-18
+
+#### Added
+
+* [#233](https://github.com/shlinkio/shlink/issues/233) Added PHP 7.3 to build matrix allowing its failure.
+
+#### Changed
+
+* [#235](https://github.com/shlinkio/shlink/issues/235) Improved update instructions (thanks to [tivyhosting](https://github.com/tivyhosting)).
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#237](https://github.com/shlinkio/shlink/issues/233) Solved errors when trying to geo-locate `null` IP addresses.
+
+    Also improved how visitor IP addresses are discovered, thanks to [akrabat/ip-address-middleware](https://github.com/akrabat/ip-address-middleware) package.
+
+
+## 1.13.1 - 2018-10-16
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* *Nothing*
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#231](https://github.com/shlinkio/shlink/issues/197) Fixed error when processing visits.
+
+
+## 1.13.0 - 2018-10-06
+
+#### Added
+
+* [#197](https://github.com/shlinkio/shlink/issues/197) Added [cakephp/chronos](https://book.cakephp.org/3.0/en/chronos.html) library for date manipulations.
+* [#214](https://github.com/shlinkio/shlink/issues/214) Improved build script, which allows builds to be done without "jumping" outside the project directory, and generates smaller dist files.
+
+    It also allows automating the dist file generation in travis-ci builds.
+
+* [#207](https://github.com/shlinkio/shlink/issues/207) Added two new config options which are asked during installation process. The config options already existed in previous shlink version, but you had to manually set their values.
+
+    These are the new options:
+
+    * Visits threshold to allow short URLs to be deleted.
+    * Check the visits threshold when trying to delete a short URL via REST API.
+
+#### Changed
+
+* [#211](https://github.com/shlinkio/shlink/issues/211) Extracted installer to its own module, which will simplify moving it to a separated package in the future.
+* [#200](https://github.com/shlinkio/shlink/issues/200) and [#201](https://github.com/shlinkio/shlink/issues/201) Renamed REST Action classes and CLI Command classes to use the concept of `ShortUrl` instead of the concept of `ShortCode` when referring to the entity, and left the `short code` concept to the identifier which is used as a unique code for a specific `Short URL`.
+* [#181](https://github.com/shlinkio/shlink/issues/181) When importing the configuration from a previous shlink installation, it no longer asks to import every block. Instead, it is capable of detecting only new config options introduced in the new version, and ask only for those.
+
+    If no new options are found and you have selected to import config, no further questions will be asked and shlink will just import the old config.
+
+#### Deprecated
+
+* [#205](https://github.com/shlinkio/shlink/issues/205) Deprecated `[POST /authenticate]` endpoint, and allowed any API request to be automatically authenticated using the `X-Api-Key` header with a valid API key.
+
+    This effectively deprecates the `Authorization: Bearer <JWT>` authentication form, but it will keep working.
+
+* As of [#200](https://github.com/shlinkio/shlink/issues/200) and [#201](https://github.com/shlinkio/shlink/issues/201) REST urls have changed from `/short-codes/...` to `/short-urls/...`, and the command namespaces have changed from `short-code:...` to `short-url:...`.
+
+    In both cases, backwards compatibility has been retained and the old ones are aliases for the new ones, but the old ones are considered deprecated.
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#203](https://github.com/shlinkio/shlink/issues/203) Fixed some warnings thrown while unzipping distributable files.
+* [#206](https://github.com/shlinkio/shlink/issues/206) An error is now thrown during installation if any required param is left empty, making the installer display a message and ask again until a value is set.
+
+
+## 1.12.0 - 2018-09-15
+
+#### Added
+
+* [#187](https://github.com/shlinkio/shlink/issues/187) Included an API endpoint and a CLI command to delete short URLs.
+
+    Due to the implicit danger of this operation, the deletion includes a safety check. URLs cannot be deleted if they have more than a specific amount of visits.
+
+    The visits threshold is set to **15** by default and currently it has to be manually changed. In future versions the installation/update process will ask you about the value of the visits threshold.
+
+    In order to change it, open the `config/autoload/delete_short_urls.global.php` file, which has this structure:
+
+    ```php
+    return [
+
+        'delete_short_urls' => [
+            'visits_threshold' => 15,
+            'check_visits_threshold' => true,
+        ],
+
+    ];
+    ```
+
+    Properties are self explanatory. Change `check_visits_threshold` to `false` to completely disable this safety check, and change the value of `visits_threshold` to allow short URLs with a different number of visits to be deleted.
+
+    Once changed, delete the `data/cache/app_config.php` file (if any) to let shlink know about the new values.
+
+    This check is implicit for the API endpoint, but can be "disabled" for the CLI command, which will ask you when trying to delete a URL which has reached to threshold in order to force the deletion.
+
+* [#183](https://github.com/shlinkio/shlink/issues/183) and [#190](https://github.com/shlinkio/shlink/issues/190) Included important documentation improvements in the repository itself. You no longer need to go to the website in order to see how to install or use shlink.
+* [#186](https://github.com/shlinkio/shlink/issues/186) Added a small robots.txt file that prevents 404 errors to be logged due to search engines trying to index the domain where shlink is located. Thanks to [@robwent](https://github.com/robwent) for the contribution.
+
+#### Changed
+
+* [#145](https://github.com/shlinkio/shlink/issues/145) Shlink now obfuscates IP addresses from visitors by replacing the latest octet by `0`, which does not affect geolocation and allows it to fulfil the GDPR.
+
+    Other known services follow this same approach, like [Google Analytics](https://support.google.com/analytics/answer/2763052?hl=en) or [Matomo](https://matomo.org/docs/privacy/#step-1-automatically-anonymize-visitor-ips)
+
+* [#182](https://github.com/shlinkio/shlink/issues/182) The short URL creation API endpoints now return the same model used for lists and details endpoints.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#188](https://github.com/shlinkio/shlink/issues/188) Shlink now allows multiple short URLs to be created that resolve to the same long URL.
+
+
+## 1.11.0 - 2018-08-13
+
+#### Added
+
+* [#170](https://github.com/shlinkio/shlink/issues/170) and [#171](https://github.com/shlinkio/shlink/issues/171) Updated `[GET /short-codes]` and `[GET /short-codes/{shortCode}]` endpoints to return more meaningful information and make their response consistent.
+
+    The short URLs are now represented by this object in both cases:
+
+    ```json
+    {
+        "shortCode": "12Kb3",
+        "shortUrl": "https://doma.in/12Kb3",
+        "longUrl": "https://shlink.io",
+        "dateCreated": "2016-05-01T20:34:16+02:00",
+        "visitsCount": 1029,
+        "tags": [
+            "shlink"
+        ],
+        "originalUrl": "https://shlink.io"
+    }
+    ```
+
+    The `originalUrl` property is considered deprecated and has been kept for backward compatibility purposes. It holds the same value as the `longUrl` property.
+
+#### Changed
+
+* *Nothing*
+
+#### Deprecated
+
+* The `originalUrl` property in `[GET /short-codes]` and `[GET /short-codes/{shortCode}]` endpoints is now deprecated and replaced by the `longUrl` property.
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* *Nothing*
+
+
 ## 1.10.2 - 2018-08-04
 
 #### Added

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Alejandro Celaya
+Copyright (c) 2016-2019 Alejandro Celaya
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,288 @@
 # Shlink
 
-[![Build Status](https://travis-ci.org/shlinkio/shlink.svg?branch=master)](https://travis-ci.org/shlinkio/shlink)
-[![Code Coverage](https://scrutinizer-ci.com/g/shlinkio/shlink/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/shlinkio/shlink/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
-[![Latest Stable Version](https://poser.pugx.org/shlinkio/shlink/v/stable.png)](https://packagist.org/packages/shlinkio/shlink)
-[![License](https://poser.pugx.org/shlinkio/shlink/license.png)](https://packagist.org/packages/shlinkio/shlink)
+[![Build Status](https://img.shields.io/travis/shlinkio/shlink.svg?style=flat-square)](https://travis-ci.org/shlinkio/shlink)
+[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
+[![Latest Stable Version](https://img.shields.io/github/release/shlinkio/shlink.svg?style=flat-square)](https://packagist.org/packages/shlinkio/shlink)
+[![License](https://img.shields.io/github/license/shlinkio/shlink.svg?style=flat-square)](https://github.com/shlinkio/shlink/blob/master/LICENSE)
+[![Paypal donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=aaaaaa)](https://acel.me/donate)
 
-A PHP-based URL shortener application with analytics and management
+A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Update to new version](#update-to-new-version)
+- [Using a docker image](#using-a-docker-image)
+- [Using shlink](#using-shlink)
+  - [Shlink CLI Help](#shlink-cli-help)
+
+## Installation
+
+First make sure the host where you are going to run shlink fulfills these requirements:
+
+* PHP 7.1 or greater with JSON, APCu, intl, curl, PDO and gd extensions enabled.
+* MySQL, PostgreSQL or SQLite.
+* The web server of your choice with PHP integration (Apache or Nginx recommended).
+
+Then, you will need a built version of the project. There are a few ways to get it.
+
+* **Using a dist file**
+
+    The easiest way to install shlink is by using one of the pre-bundled distributable packages.
+
+    Just go to the [latest version](https://github.com/shlinkio/shlink/releases/latest) and download the `shlink_X.X.X_dist.zip` file you will find there.
+
+    Finally, decompress the file in the location of your choice.
+
+* **Building from sources**
+
+    If for any reason you want to build the project yourself, follow these steps:
+
+    * Clone the project with git (`git clone https://github.com/shlinkio/shlink.git`), or download it by clicking the **Clone or download** green button.
+    * Download the [Composer](https://getcomposer.org/download/) PHP package manager inside the project folder.
+    * Run `./build.sh 1.0.0`, replacing the version with the version number you are going to build (the version number is only used for the generated dist file).
+
+    After that, you will have a `shlink_x.x.x_dist.zip` dist file inside the `build` directory.
+
+    This is the process used when releasing new shlink versions. After tagging the new version with git, the Github release is automatically created by [travis](https://travis-ci.org/shlinkio/shlink), attaching generated dist file to it.
+
+Despite how you built the project, you are going to need to install it now, by following these steps:
+
+* If you are going to use MySQL or PostgreSQL, create an empty database with the name of your choice.
+* Recursively grant write permissions to the `data` directory. Shlink uses it to cache some information.
+* Setup the application by running the `bin/install` script. It is a command line tool that will guide you through the installation process. **Take into account that this tool has to be run directly on the server where you plan to host Shlink. Do not run it before uploading/moving it there.**
+* Expose shlink to the web, either by using a traditional web server + fast CGI approach, or by using a [swoole](https://www.swoole.co.uk/) non-blocking server.
+
+    * **Using a web server:**
+
+        For example, assuming your domain is doma.in and shlink is in the `/path/to/shlink` folder, these would be the basic configurations for Nginx and Apache.
+
+        *Nginx:*
+
+        ```nginx
+        server {
+            server_name doma.in;
+            listen 80;
+            root /path/to/shlink/public;
+            index index.php;
+            charset utf-8;
+
+            location / {
+                try_files $uri $uri/ /index.php$is_args$args;
+            }
+
+            location ~ \.php$ {
+                fastcgi_split_path_info ^(.+\.php)(/.+)$;
+                fastcgi_pass unix:/var/run/php/php7.1-fpm.sock;
+                fastcgi_index index.php;
+                include fastcgi.conf;
+            }
+
+            location ~ /\.ht {
+                deny all;
+            }
+        }
+        ```
+
+        *Apache:*
+
+        ```apache
+        <VirtualHost *:80>
+            ServerName doma.in
+            DocumentRoot "/path/to/shlink/public"
+
+            <Directory "/path/to/shlink/public">
+                Options FollowSymLinks Includes ExecCGI
+                AllowOverride all
+                Order allow,deny
+                Allow from all
+            </Directory>
+        </VirtualHost>
+        ```
+
+    * **Using swoole:**
+
+        **Important!** Swoole support is still experimental. Use it with care, and report any found issue.
+
+        First you need to install the swoole PHP extension with [pecl](https://pecl.php.net/package/swoole), `pecl install swoole`.
+
+        Once installed, it's actually pretty easy to get shlink up and running with swoole. Just run `./vendor/bin/zend-expressive-swoole start -d` and you will get shlink running on port 8080.
+
+        However, by doing it this way, you are loosing all the access logs, and the service won't be automatically run if the server has to be restarted.
+
+        For that reason, you should create a daemon script, in `/etc/init.d/shlink_swoole`, like this one, replacing `/path/to/shlink` by the path to your shlink installation:
+
+        ```bash
+        #!/bin/bash
+        ### BEGIN INIT INFO
+        # Provides:          shlink_swoole
+        # Required-Start:    $local_fs $network $named $time $syslog
+        # Required-Stop:     $local_fs $network $named $time $syslog
+        # Default-Start:     2 3 4 5
+        # Default-Stop:      0 1 6
+        # Description:       Shlink non-blocking server with swoole
+        ### END INIT INFO
+
+        SCRIPT=/path/to/shlink/vendor/bin/zend-expressive-swoole\ start
+        RUNAS=root
+
+        PIDFILE=/var/run/shlink_swoole.pid
+        LOGDIR=/var/log/shlink
+        LOGFILE=${LOGDIR}/shlink_swoole.log
+
+        start() {
+          if [[ -f "$PIDFILE" ]] && kill -0 $(cat "$PIDFILE"); then
+            echo 'Shlink with swoole already running' >&2
+            return 1
+          fi
+          echo 'Starting shlink with swoole' >&2
+          mkdir -p "$LOGDIR"
+          touch "$LOGFILE"
+          local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!"
+          su -c "$CMD" $RUNAS > "$PIDFILE"
+          echo 'Shlink started' >&2
+        }
+
+        stop() {
+          if [[ ! -f "$PIDFILE" ]] || ! kill -0 $(cat "$PIDFILE"); then
+            echo 'Shlink with swoole not running' >&2
+            return 1
+          fi
+          echo 'Stopping shlink with swoole' >&2
+          kill -15 $(cat "$PIDFILE") && rm -f "$PIDFILE"
+          echo 'Shlink stopped' >&2
+        }
+
+        case "$1" in
+          start)
+            start
+            ;;
+          stop)
+            stop
+            ;;
+          restart)
+            stop
+            start
+            ;;
+          *)
+            echo "Usage: $0 {start|stop|restart}"
+        esac
+        ```
+
+        Then run these commands to enable the service and start it:
+
+        * `sudo chmod +x /etc/init.d/shlink_swoole`
+        * `sudo update-rc.d shlink_swoole defaults`
+        * `sudo update-rc.d shlink_swoole enable`
+        * `/etc/init.d/shlink_swoole start`
+
+        Now again, you can access shlink on port 8080, but this time the service will be automatically run at system start-up, and all access logs will be written in `/var/log/shlink/shlink_swoole.log` (you will probably want to [rotate those logs](https://www.digitalocean.com/community/tutorials/how-to-manage-logfiles-with-logrotate-on-ubuntu-16-04). You can find an example logrotate config file [here](data/infra/examples/shlink-daemon-logrotate.conf)).
+
+* Generate your first API key by running `bin/cli api-key:generate`. You will need the key in order to interact with shlink's API.
+* Finally access to [https://app.shlink.io](https://app.shlink.io) and configure your server to start creating short URLs.
+
+**Bonus**
+
+There are a couple of time-consuming tasks that shlink expects you to do manually, or at least it is recommended, since it will improve runtime performance.
+
+Those tasks can be performed using shlink's CLI, so it should be easy to schedule them to be run in the background (for example, using cron jobs):
+
+* Resolve IP address locations: `/path/to/shlink/bin/cli visit:process`
+
+    If you don't run this command regularly, the stats will say all visits come from *unknown* locations.
+
+* Update IP geolocation database: `/path/to/shlink/bin/cli visit:update-db`
+
+    When shlink is installed it downloads a fresh [GeoLite2](https://dev.maxmind.com/geoip/geoip2/geolite2/) db file. Running this command will update this file.
+
+    The file is updated the first Tuesday of every month, so it should be enough running this command the first Wednesday.
+
+* Generate website previews: `/path/to/shlink/bin/cli short-url:process-previews`
+
+    Running this will improve the performance of the `doma.in/abc123/preview` URLs, which return a preview of the site.
+
+*Any of those commands accept the `-q` flag, which makes it not display any output. This is recommended when configuring the commands as cron jobs.*
+
+In future versions, it is planed that, when using **swoole** to serve shlink, some of these tasks are automatically run without blocking the request and also, without having to configure cron jobs. Probably resolving IP locations and generating previews.
+
+## Update to new version
+
+When a new Shlink version is available, you don't need to repeat the entire process yourself. Instead, follow these steps:
+
+1. Rename your existing Shlink directory to something else (ie. `shlink` ---> `shlink-old`).
+2. Download and extract the new version of Shlink, and set the directories name to that of the old version. (ie. `shlink`).
+3. Run the `bin/update` script in the new version's directory to migrate your configuration over.
+4. If you are using shlink with swoole, restart the service by running `/etc/init.d/shlink_swoole restart`.
+
+The `bin/update` script will ask you for the location from previous shlink version, and use it in order to import the configuration. It will then update the database and generate some assets shlink needs to work.
+
+Right now, it does not import cached info (like website previews), but it will. For now you will need to regenerate them again.
+
+**Important!** It is recommended that you don't skip any version when using this process. The update gets better on every version, but older versions might make assumptions.
+
+## Using a docker image
+
+Starting with version 1.15.0, an official docker image is provided. You can find the docs on how to use it [here](https://hub.docker.com/r/shlinkio/shlink/).
+
+The idea is that you can just generate a container using the image and provide custom config via env vars.
+
+## Using shlink
+
+Once shlink is installed, there are two main ways to interact with it:
+
+* **The command line**. Try running `bin/cli` and see all the [available commands](#shlink-cli-help).
+
+    All of those commands can be run with the `--help`/`-h` flag in order to see how to use them and all the available options.
+
+    It is probably a good idea to symlink the CLI entry point (`bin/cli`) to somewhere in your path, so that you can run shlink from any directory.
+
+* **The REST API**. The complete docs on how to use the API can be found [here](https://shlink.io/api-docs), and a sandbox which also documents every endpoint can be found [here](https://shlink.io/swagger-ui/index.html).
+
+    However, you probably don't want to consume the raw API yourself. That's why a nice [web client](https://github.com/shlinkio/shlink-web-client) is provided that can be directly used from [https://app.shlink.io](https://app.shlink.io), or you can host it yourself too.
+
+Both the API and CLI allow you to do the same operations, except for API key management, which can be done from the command line interface only.
+
+### Shlink CLI Help
+
+```
+Usage:
+  command [options] [arguments]
+
+Options:
+  -h, --help            Display this help message
+  -q, --quiet           Do not output any message
+  -V, --version         Display this application version
+      --ansi            Force ANSI output
+      --no-ansi         Disable ANSI output
+  -n, --no-interaction  Do not ask any interactive question
+  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
+Available commands:
+  help                        Displays help for a command
+  list                        Lists commands
+ api-key
+  api-key:disable             Disables an API key.
+  api-key:generate            Generates a new valid API key.
+  api-key:list                Lists all the available API keys.
+ config
+  config:generate-charset     [DEPRECATED] Generates a character set sample just by shuffling the default one, "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". Then it can be set in the SHORTCODE_CHARS environment variable
+  config:generate-secret      [DEPRECATED] Generates a random secret string that can be used for JWT token encryption
+ short-url
+  short-url:delete            [short-code:delete] Deletes a short URL
+  short-url:generate          [shortcode:generate|short-code:generate] Generates a short URL for provided long URL and returns it
+  short-url:list              [shortcode:list|short-code:list] List all short URLs
+  short-url:parse             [shortcode:parse|short-code:parse] Returns the long URL behind a short code
+  short-url:process-previews  [shortcode:process-previews|short-code:process-previews] Processes and generates the previews for every URL, improving performance for later web requests.
+  short-url:visits            [shortcode:visits|short-code:visits] Returns the detailed visits information for provided short code
+ tag
+  tag:create                  Creates one or more tags.
+  tag:delete                  Deletes one or more tags.
+  tag:list                    Lists existing tags.
+  tag:rename                  Renames one existing tag.
+ visit
+  visit:process               Processes visits where location is not set yet
+  visit:update-db             Updates the GeoLite2 database file used to geolocate IP addresses
+```
+
+> This product includes GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com)

bin/install

@@ -1,29 +1,12 @@
 #!/usr/bin/env php
 <?php
+declare(strict_types=1);
 
-use Shlinkio\Shlink\CLI\Factory\InstallApplicationFactory;
-use Shlinkio\Shlink\CLI\Install\Plugin\DatabaseConfigCustomizer;
-use Symfony\Component\Console\Application;
-use Symfony\Component\Filesystem\Filesystem;
-use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
-use Zend\ServiceManager\Factory\InvokableFactory;
-use Zend\ServiceManager\ServiceManager;
+namespace Shlinkio\Shlink;
+
+use function chdir;
+use function dirname;
 
 chdir(dirname(__DIR__));
-
-require __DIR__ . '/../vendor/autoload.php';
-
-$container = new ServiceManager([
-    'factories' => [
-        Application::class => InstallApplicationFactory::class,
-        Filesystem::class => InvokableFactory::class,
-    ],
-    'services' => [
-        'config' => [
-            ConfigAbstractFactory::class => [
-                DatabaseConfigCustomizer::class => [Filesystem::class]
-            ],
-        ],
-    ],
-]);
-$container->build(Application::class)->run();
+$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$run(false);

bin/test/run-api-tests.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env sh
+set -e
+
+export APP_ENV=test
+
+# Try to stop server just in case it hanged in last execution
+vendor/bin/zend-expressive-swoole stop
+
+echo 'Starting server...'
+vendor/bin/zend-expressive-swoole start -d
+sleep 2
+
+vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox
+vendor/bin/zend-expressive-swoole stop

bin/update

@@ -1,29 +1,12 @@
 #!/usr/bin/env php
 <?php
+declare(strict_types=1);
 
-use Shlinkio\Shlink\CLI\Factory\InstallApplicationFactory;
-use Shlinkio\Shlink\CLI\Install\Plugin\DatabaseConfigCustomizer;
-use Symfony\Component\Console\Application;
-use Symfony\Component\Filesystem\Filesystem;
-use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
-use Zend\ServiceManager\Factory\InvokableFactory;
-use Zend\ServiceManager\ServiceManager;
+namespace Shlinkio\Shlink;
+
+use function chdir;
+use function dirname;
 
 chdir(dirname(__DIR__));
-
-require __DIR__ . '/../vendor/autoload.php';
-
-$container = new ServiceManager([
-    'factories' => [
-        Application::class => InstallApplicationFactory::class,
-        Filesystem::class => InvokableFactory::class,
-    ],
-    'services' => [
-        'config' => [
-            ConfigAbstractFactory::class => [
-                DatabaseConfigCustomizer::class => [Filesystem::class]
-            ],
-        ],
-    ],
-]);
-$container->build(Application::class, ['isUpdate' => true])->run();
+$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$run(true);

build.sh

@@ -1,55 +1,62 @@
 #!/usr/bin/env bash
 set -e
 
-if [ "$#" -ne 1 ]; then
+if [[ "$#" -ne 1 ]]; then
   echo "Usage:" >&2
   echo "   $0 {version}" >&2
   exit 1
 fi
 
 version=$1
-builtcontent=$(readlink -f "../shlink_${version}_dist")
+builtcontent="./build/shlink_${version}_dist"
 projectdir=$(pwd)
+[[ -f ./composer.phar ]] && composerBin='./composer.phar' || composerBin='composer'
 
 # Copy project content to temp dir
 echo 'Copying project files...'
 rm -rf "${builtcontent}"
-mkdir "${builtcontent}"
-sudo chmod -R 777 "${projectdir}"/data/infra/{database,nginx}
-cp -R "${projectdir}"/* "${builtcontent}"
+mkdir -p "${builtcontent}"
+rsync -av * "${builtcontent}" \
+    --exclude=bin/test \
+    --exclude=data/infra \
+    --exclude=data/travis \
+    --exclude=data/migrations_template.txt \
+    --exclude=data/GeoLite2-City.mmdb \
+    --exclude=**/.gitignore \
+    --exclude=CHANGELOG.md \
+    --exclude=composer.lock \
+    --exclude=vendor \
+    --exclude=docs \
+    --exclude=indocker \
+    --exclude=docker* \
+    --exclude=php* \
+    --exclude=infection.json \
+    --exclude=phpstan.neon \
+    --exclude=config/autoload/*local* \
+    --exclude=config/test \
+    --exclude=**/test* \
+    --exclude=build*
 cd "${builtcontent}"
 
 # Install dependencies
-rm -rf vendor
-rm -f composer.lock
-composer self-update
-composer install --no-dev --optimize-autoloader --no-progress --no-interaction
+echo "Installing dependencies with $composerBin..."
+${composerBin} self-update
+${composerBin} install --no-dev --optimize-autoloader --apcu-autoloader --no-progress --no-interaction
 
 # Delete development files
 echo 'Deleting dev files...'
-rm build.sh
-rm CHANGELOG.md
 rm composer.*
-rm LICENSE
-rm indocker
-rm docker-compose.yml
-rm docker-compose.override.yml
-rm docker-compose.override.yml.dist
-rm func_tests_bootstrap.php
-rm php*
-rm README.md
-rm infection.json
-rm -rf build
-rm -ff data/database.sqlite
-rm -rf data/infra
-rm -rf data/{cache,log,proxies}/{*,.gitignore}
-rm -rf config/params/{*,.gitignore}
-rm -rf config/autoload/{{,*.}local.php{,.dist},.gitignore}
+rm -f data/database.sqlite
 
 # Update shlink version in config
 sed -i "s/%SHLINK_VERSION%/${version}/g" config/autoload/app_options.global.php
 
 # Compressing file
-rm -f "${projectdir}"/build/shlink_${version}_dist.zip
-zip -ry "${projectdir}"/build/shlink_${version}_dist.zip "../shlink_${version}_dist"
+echo 'Compressing files...'
+cd "${projectdir}"/build
+rm -f ./shlink_${version}_dist.zip
+zip -ry ./shlink_${version}_dist.zip ./shlink_${version}_dist
+cd "${projectdir}"
 rm -rf "${builtcontent}"
+
+echo 'Done!'

composer.json

@@ -13,28 +13,36 @@
     ],
     "require": {
         "php": "^7.1",
+        "ext-json": "*",
+        "ext-pdo": "*",
         "acelaya/ze-content-based-error-handler": "^2.2",
+        "akrabat/ip-address-middleware": "^1.0",
+        "cakephp/chronos": "^1.2",
         "cocur/slugify": "^3.0",
         "doctrine/cache": "^1.6",
         "doctrine/migrations": "^1.4",
         "doctrine/orm": "^2.5",
         "endroid/qr-code": "^1.7",
         "firebase/php-jwt": "^4.0",
+        "geoip2/geoip2": "^2.9",
         "guzzlehttp/guzzle": "^6.2",
+        "lstrojny/functional-php": "^1.8",
         "mikehaertl/phpwkhtmltopdf": "^2.2",
         "monolog/monolog": "^1.21",
-        "roave/security-advisories": "dev-master",
-        "symfony/console": "^4.0",
-        "symfony/filesystem": "^4.0",
-        "symfony/process": "^4.0",
+        "shlinkio/shlink-installer": "^1.1",
+        "symfony/console": "^4.2",
+        "symfony/filesystem": "^4.2",
+        "symfony/lock": "^4.2",
+        "symfony/process": "^4.2",
         "theorchard/monolog-cascade": "^0.4",
         "zendframework/zend-config": "^3.0",
         "zendframework/zend-config-aggregator": "^1.0",
-        "zendframework/zend-diactoros": "^1.7",
+        "zendframework/zend-diactoros": "^2.1.1",
         "zendframework/zend-expressive": "^3.0",
         "zendframework/zend-expressive-fastroute": "^3.0",
         "zendframework/zend-expressive-helpers": "^5.0",
         "zendframework/zend-expressive-platesrenderer": "^2.0",
+        "zendframework/zend-expressive-swoole": "^2.2",
         "zendframework/zend-i18n": "^2.7",
         "zendframework/zend-inputfilter": "^2.8",
         "zendframework/zend-paginator": "^2.6",
@@ -42,15 +50,17 @@
         "zendframework/zend-stdlib": "^3.0"
     },
     "require-dev": {
+        "devster/ubench": "^2.0",
+        "doctrine/data-fixtures": "^1.3",
         "filp/whoops": "^2.0",
-        "infection/infection": "^0.9.0",
-        "phpstan/phpstan": "^0.10.0",
-        "phpunit/phpcov": "^5.0",
-        "phpunit/phpunit": "^7.0",
-        "slevomat/coding-standard": "^4.0",
-        "squizlabs/php_codesniffer": "^3.2.3",
-        "symfony/dotenv": "^4.0",
-        "symfony/var-dumper": "^4.0",
+        "infection/infection": "^0.12.2",
+        "phpstan/phpstan": "^0.11.2",
+        "phpunit/phpcov": "^6.0@dev || ^5.0",
+        "phpunit/phpunit": "^8.0 || ^7.5",
+        "roave/security-advisories": "dev-master",
+        "shlinkio/php-coding-standard": "~1.1.0",
+        "symfony/dotenv": "^4.2",
+        "symfony/var-dumper": "^4.2",
         "zendframework/zend-component-installer": "^2.1",
         "zendframework/zend-expressive-tooling": "^1.0"
     },
@@ -69,45 +79,78 @@
         "psr-4": {
             "ShlinkioTest\\Shlink\\CLI\\": "module/CLI/test",
             "ShlinkioTest\\Shlink\\Rest\\": "module/Rest/test",
+            "ShlinkioApiTest\\Shlink\\Rest\\": "module/Rest/test-api",
             "ShlinkioTest\\Shlink\\Core\\": [
                 "module/Core/test",
-                "module/Core/test-func"
+                "module/Core/test-db"
             ],
             "ShlinkioTest\\Shlink\\Common\\": [
                 "module/Common/test",
-                "module/Common/test-func"
+                "module/Common/test-db"
             ]
         }
     },
     "scripts": {
-        "check": [
+        "ci": [
             "@cs",
             "@stan",
-            "@test",
-            "@func-test",
-            "@infect"
+            "@test:ci",
+            "@infect:ci"
         ],
+
         "cs": "phpcs",
-        "cs-fix": "phpcbf",
-        "serve": "php -S 0.0.0.0:8000 -t public/",
-        "test": "phpunit --coverage-php build/coverage-unit.cov",
-        "pretty-test": "phpunit --coverage-html build/coverage",
-        "func-test": "phpunit -c phpunit-func.xml --coverage-php build/coverage-func.cov",
-        "complete-pretty-test": [
-            "@test",
-            "@func-test",
-            "phpcov merge build --html build/html"
+        "cs:fix": "phpcbf",
+        "stan": "phpstan analyse module/*/src/ --level=5 -c phpstan.neon",
+
+        "test": [
+            "@test:unit",
+            "@test:db",
+            "@test:api"
         ],
-        "stan": "phpstan analyse module/*/src/ --level=6 -c phpstan.neon",
-        "infect": "infection --threads=4 --min-msi=55 --only-covered --log-verbosity=2",
-        "infect-show": "infection --threads=4 --min-msi=55 --only-covered --log-verbosity=2 --show-mutations",
-        "expressive": "expressive"
+        "test:ci": [
+            "@test:unit:ci",
+            "@test:db",
+            "@test:api"
+        ],
+        "test:unit": "phpdbg -qrr vendor/bin/phpunit --order-by=random --coverage-php build/coverage-unit.cov --testdox",
+        "test:unit:ci": "phpdbg -qrr vendor/bin/phpunit --order-by=random --coverage-php build/coverage-unit.cov --coverage-clover=build/clover.xml --coverage-xml=build/coverage-xml --log-junit=build/phpunit.junit.xml --testdox",
+        "test:db": "APP_ENV=test phpdbg -qrr vendor/bin/phpunit --order-by=random -c phpunit-db.xml --coverage-php build/coverage-db.cov --testdox",
+        "test:api": "bin/test/run-api-tests.sh",
+
+        "test:pretty": [
+            "@test",
+            "phpdbg -qrr vendor/bin/phpcov merge build --html build/html"
+        ],
+        "test:unit:pretty": "phpdbg -qrr vendor/bin/phpunit --coverage-html build/coverage --order-by=random",
+
+        "infect": "infection --threads=4 --min-msi=70 --log-verbosity=default --only-covered",
+        "infect:ci": "infection --threads=4 --min-msi=70 --log-verbosity=default --only-covered --coverage=build",
+        "infect:show": "infection --threads=4 --min-msi=70 --log-verbosity=default --only-covered --show-mutations",
+        "infect:test": [
+            "@test:unit:ci",
+            "@infect:ci"
+        ]
+    },
+    "scripts-descriptions": {
+        "check": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"test\" and \"infect\"</>",
+        "ci": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"test:ci\" and \"infect:ci\"</>",
+        "cs": "<fg=blue;options=bold>Checks coding styles</>",
+        "cs:fix": "<fg=blue;options=bold>Fixes coding styles, when possible</>",
+        "stan": "<fg=blue;options=bold>Inspects code with phpstan</>",
+        "test": "<fg=blue;options=bold>Runs all test suites</>",
+        "test:ci": "<fg=blue;options=bold>Runs all test suites, generating all needed reports and logs for CI envs</>",
+        "test:unit": "<fg=blue;options=bold>Runs unit test suites</>",
+        "test:unit:ci": "<fg=blue;options=bold>Runs unit test suites, generating all needed reports and logs for CI envs</>",
+        "test:db": "<fg=blue;options=bold>Runs database test suites (covering entity repositories)</>",
+        "test:api": "<fg=blue;options=bold>Runs API test suites</>",
+        "test:pretty": "<fg=blue;options=bold>Runs all test suites and generates an HTML code coverage report</>",
+        "test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
+        "infect": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing</>",
+        "infect:ci": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing with existing reports and logs</>",
+        "infect:show": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing and shows applied mutators</>",
+        "infect:test": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing</>"
     },
     "config": {
-        "process-timeout": 0,
-        "sort-packages": true,
-        "platform": {
-            "php": "7.1.8"
-        }
+        "sort-packages": true
     }
 }

config/autoload/app_options.global.php

@@ -8,7 +8,8 @@ return [
     'app_options' => [
         'name' => 'Shlink',
         'version' => '%SHLINK_VERSION%',
-        'secret_key' => env('SECRET_KEY'),
+        'secret_key' => env('SECRET_KEY', ''),
+        'disable_track_param' => null,
     ],
 
 ];

config/autoload/delete_short_urls.global.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+return [
+
+    'delete_short_urls' => [
+        'visits_threshold' => 15,
+        'check_visits_threshold' => true,
+    ],
+
+];

config/autoload/dependencies.global.php

@@ -4,18 +4,13 @@ declare(strict_types=1);
 use Shlinkio\Shlink\Common\Factory\EmptyResponseImplicitOptionsMiddlewareFactory;
 use Zend\Expressive;
 use Zend\Expressive\Container;
-use Zend\Expressive\Helper;
 use Zend\Expressive\Router\Middleware\ImplicitOptionsMiddleware;
-use Zend\ServiceManager\Factory\InvokableFactory;
 
 return [
 
     'dependencies' => [
         'factories' => [
             ImplicitOptionsMiddleware::class => EmptyResponseImplicitOptionsMiddlewareFactory::class,
-
-            Helper\UrlHelper::class => Helper\UrlHelperFactory::class,
-            Helper\ServerUrlHelper::class => InvokableFactory::class,
         ],
 
         'delegators' => [
@@ -23,6 +18,12 @@ return [
                 Container\ApplicationConfigInjectionDelegator::class,
             ],
         ],
+
+        'lazy_services' => [
+            'proxies_target_dir' => 'data/proxies',
+            'proxies_namespace' => 'ShlinkProxy',
+            'write_proxy_files' => true,
+        ],
     ],
 
 ];

config/autoload/dependencies.local.php.dist

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types=1);
+
+use Psr\Container\ContainerInterface;
+use Psr\Log;
+
+return [
+
+    'dependencies' => [
+        'lazy_services' => [
+            'write_proxy_files' => false,
+        ],
+
+        'initializers' => [
+            function (ContainerInterface $container, $instance) {
+                if ($instance instanceof Log\LoggerAwareInterface) {
+                    $instance->setLogger($container->get(Log\LoggerInterface::class));
+                }
+            },
+        ],
+    ],
+
+];

config/autoload/entity-manager.global.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-use Shlinkio\Shlink\Common;
+use function Shlinkio\Shlink\Common\env;
 
 return [
 
@@ -10,9 +10,9 @@ return [
             'proxies_dir' => 'data/proxies',
         ],
         'connection' => [
-            'user' => Common\env('DB_USER'),
-            'password' => Common\env('DB_PASSWORD'),
-            'dbname' => Common\env('DB_NAME', 'shlink'),
+            'user' => env('DB_USER'),
+            'password' => env('DB_PASSWORD'),
+            'dbname' => env('DB_NAME', 'shlink'),
             'charset' => 'utf8',
         ],
     ],

config/autoload/errorhandler.local.php.dist

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 use Zend\Expressive\Container\WhoopsErrorResponseGeneratorFactory;
 
 return [

config/autoload/geolite2.global.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+return [
+
+    'geolite2' => [
+        'db_location' => __DIR__ . '/../../data/GeoLite2-City.mmdb',
+        'temp_dir' => sys_get_temp_dir(),
+        'download_from' => 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz',
+    ],
+
+];

config/autoload/installer.global.php

@@ -0,0 +1,39 @@
+<?php
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Installer\Config\Plugin;
+
+return [
+
+    'installer_plugins_expected_config' => [
+        Plugin\LanguageConfigCustomizer::class => [
+            Plugin\LanguageConfigCustomizer::DEFAULT_LANG,
+        ],
+
+        Plugin\UrlShortenerConfigCustomizer::class => [
+            Plugin\UrlShortenerConfigCustomizer::SCHEMA,
+            Plugin\UrlShortenerConfigCustomizer::HOSTNAME,
+            Plugin\UrlShortenerConfigCustomizer::CHARS,
+            Plugin\UrlShortenerConfigCustomizer::VALIDATE_URL,
+            Plugin\UrlShortenerConfigCustomizer::ENABLE_NOT_FOUND_REDIRECTION,
+            Plugin\UrlShortenerConfigCustomizer::NOT_FOUND_REDIRECT_TO,
+        ],
+
+        Plugin\ApplicationConfigCustomizer::class => [
+            Plugin\ApplicationConfigCustomizer::SECRET,
+            Plugin\ApplicationConfigCustomizer::DISABLE_TRACK_PARAM,
+            Plugin\ApplicationConfigCustomizer::CHECK_VISITS_THRESHOLD,
+            Plugin\ApplicationConfigCustomizer::VISITS_THRESHOLD,
+        ],
+
+        Plugin\DatabaseConfigCustomizer::class => [
+            Plugin\DatabaseConfigCustomizer::DRIVER,
+            Plugin\DatabaseConfigCustomizer::NAME,
+            Plugin\DatabaseConfigCustomizer::USER,
+            Plugin\DatabaseConfigCustomizer::PASSWORD,
+            Plugin\DatabaseConfigCustomizer::HOST,
+            Plugin\DatabaseConfigCustomizer::PORT,
+        ],
+    ],
+
+];

config/autoload/local.php.dist

@@ -1,8 +1,11 @@
 <?php
+declare(strict_types=1);
+
+use Zend\ConfigAggregator\ConfigAggregator;
 
 return [
 
     'debug' => true,
-    'config_cache_enabled' => false,
+    ConfigAggregator::ENABLE_CACHE => false,
 
 ];

config/autoload/locks.global.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+
+use Symfony\Component\Lock;
+use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+
+return [
+
+    'locks' => [
+        'locks_dir' => __DIR__ . '/../../data/locks',
+    ],
+
+    'dependencies' => [
+        'factories' => [
+            Lock\Store\FlockStore::class => ConfigAbstractFactory::class,
+            Lock\Factory::class => ConfigAbstractFactory::class,
+        ],
+    ],
+
+    ConfigAbstractFactory::class => [
+        Lock\Store\FlockStore::class => ['config.locks.locks_dir'],
+        Lock\Factory::class => [Lock\Store\FlockStore::class],
+    ],
+
+];

config/autoload/logger.global.php

@@ -1,32 +1,72 @@
 <?php
 declare(strict_types=1);
 
+namespace Shlinkio\Shlink;
+
 use Monolog\Handler\RotatingFileHandler;
+use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
+use Monolog\Processor;
+
+use const PHP_EOL;
 
 return [
 
     'logger' => [
         'formatters' => [
             'dashed' => [
-                'format' => '[%datetime%] %channel%.%level_name% - %message% %context%' . PHP_EOL,
+                'format' => '[%datetime%] %channel%.%level_name% - %message%' . PHP_EOL,
                 'include_stacktraces' => true,
             ],
         ],
 
         'handlers' => [
-            'rotating_file_handler' => [
+            'shlink_rotating_handler' => [
                 'class' => RotatingFileHandler::class,
                 'level' => Logger::INFO,
                 'filename' => 'data/log/shlink_log.log',
                 'max_files' => 30,
                 'formatter' => 'dashed',
             ],
+            'swoole_access_handler' => [
+                'class' => StreamHandler::class,
+                'level' => Logger::INFO,
+                'stream' => 'php://stdout',
+            ],
+        ],
+
+        'processors' => [
+            'exception_with_new_line' => [
+                'class' => Common\Logger\Processor\ExceptionWithNewLineProcessor::class,
+            ],
+            'psr3' => [
+                'class' => Processor\PsrLogMessageProcessor::class,
+            ],
         ],
 
         'loggers' => [
             'Shlink' => [
-                'handlers' => ['rotating_file_handler'],
+                'handlers' => ['shlink_rotating_handler'],
+                'processors' => ['exception_with_new_line', 'psr3'],
+            ],
+            'Swoole' => [
+                'handlers' => ['swoole_access_handler'],
+                'processors' => ['psr3'],
+            ],
+        ],
+    ],
+
+    'dependencies' => [
+        'factories' => [
+            'Logger_Shlink' => Common\Factory\LoggerFactory::class,
+            'Logger_Swoole' => Common\Factory\LoggerFactory::class,
+        ],
+    ],
+
+    'zend-expressive-swoole' => [
+        'swoole-http-server' => [
+            'logger' => [
+                'logger-name' => 'Logger_Swoole',
             ],
         ],
     ],

config/autoload/logger.local.php.dist

@@ -1,11 +1,13 @@
 <?php
+declare(strict_types=1);
+
 use Monolog\Logger;
 
 return [
 
     'logger' => [
         'handlers' => [
-            'rotating_file_handler' => [
+            'shlink_rotating_handler' => [
                 'level' => Logger::DEBUG,
             ],
         ],

config/autoload/middleware-pipeline.global.php

@@ -1,12 +1,8 @@
 <?php
 declare(strict_types=1);
 
-use Shlinkio\Shlink\Common\Middleware\LocaleMiddleware;
-use Shlinkio\Shlink\Core\Response\NotFoundHandler;
-use Shlinkio\Shlink\Rest\Middleware\BodyParserMiddleware;
-use Shlinkio\Shlink\Rest\Middleware\CheckAuthenticationMiddleware;
-use Shlinkio\Shlink\Rest\Middleware\CrossDomainMiddleware;
-use Shlinkio\Shlink\Rest\Middleware\PathVersionMiddleware;
+namespace Shlinkio\Shlink;
+
 use Zend\Expressive;
 use Zend\Stratigility\Middleware\ErrorHandler;
 
@@ -17,14 +13,15 @@ return [
             'middleware' => [
                 ErrorHandler::class,
                 Expressive\Helper\ContentLengthMiddleware::class,
-                LocaleMiddleware::class,
+                Common\Middleware\CloseDbConnectionMiddleware::class,
             ],
-            'priority' => 11,
+            'priority' => 12,
         ],
         'pre-routing-rest' => [
             'path' => '/rest',
             'middleware' => [
-                PathVersionMiddleware::class,
+                Rest\Middleware\PathVersionMiddleware::class,
+                Rest\Middleware\ShortUrl\ShortCodePathMiddleware::class,
             ],
             'priority' => 11,
         ],
@@ -39,10 +36,10 @@ return [
         'rest' => [
             'path' => '/rest',
             'middleware' => [
-                CrossDomainMiddleware::class,
+                Rest\Middleware\CrossDomainMiddleware::class,
                 Expressive\Router\Middleware\ImplicitOptionsMiddleware::class,
-                BodyParserMiddleware::class,
-                CheckAuthenticationMiddleware::class,
+                Rest\Middleware\BodyParserMiddleware::class,
+                Rest\Middleware\AuthenticationMiddleware::class,
             ],
             'priority' => 5,
         ],
@@ -50,7 +47,10 @@ return [
         'post-routing' => [
             'middleware' => [
                 Expressive\Router\Middleware\DispatchMiddleware::class,
-                NotFoundHandler::class,
+
+                // Only if a not found error is triggered, set-up the locale to be used
+                Common\Middleware\LocaleMiddleware::class,
+                Core\Response\NotFoundHandler::class,
             ],
             'priority' => 1,
         ],

config/autoload/swoole.global.php

@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+return [
+
+    'zend-expressive-swoole' => [
+        'enable_coroutine' => true,
+
+        'swoole-http-server' => [
+            'host' => '0.0.0.0',
+            'process-name' => 'shlink',
+        ],
+    ],
+
+];

config/autoload/url-shortener.global.php

@@ -1,7 +1,8 @@
 <?php
 declare(strict_types=1);
 
-use Shlinkio\Shlink\Core\Service\UrlShortener;
+use Shlinkio\Shlink\Core\Options\UrlShortenerOptions;
+
 use function Shlinkio\Shlink\Common\env;
 
 return [
@@ -11,8 +12,12 @@ return [
             'schema' => env('SHORTENED_URL_SCHEMA', 'http'),
             'hostname' => env('SHORTENED_URL_HOSTNAME'),
         ],
-        'shortcode_chars' => env('SHORTCODE_CHARS', UrlShortener::DEFAULT_CHARS),
+        'shortcode_chars' => env('SHORTCODE_CHARS', UrlShortenerOptions::DEFAULT_CHARS),
         'validate_url' => true,
+        'not_found_short_url' => [
+            'enable_redirection' => false,
+            'redirect_to' => null,
+        ],
     ],
 
 ];

config/autoload/wkhtmltopdf.global.php

@@ -3,9 +3,9 @@ declare(strict_types=1);
 
 return [
 
-    'phpwkhtmltopdf' => [
+    'wkhtmltopdf' => [
         'images' => [
-            'binary' => 'bin/wkhtmltoimage',
+            'binary' => __DIR__ . '/../../bin/wkhtmltoimage',
             'type' => 'jpg',
         ],
     ],

config/autoload/zend-expressive.global.php

@@ -1,9 +1,11 @@
 <?php
 declare(strict_types=1);
 
+use Zend\ConfigAggregator\ConfigAggregator;
+
 return [
 
     'debug' => false,
-    'config_cache_enabled' => true,
+    ConfigAggregator::ENABLE_CACHE => true,
 
 ];

config/cli-config.php

@@ -6,30 +6,8 @@ use Doctrine\ORM\Tools\Console\ConsoleRunner;
 use Interop\Container\ContainerInterface;
 use Zend\ServiceManager\ServiceManager;
 
-$isTest = false;
-foreach ($_SERVER['argv'] as $i => $arg) {
-    if ($arg === '--test') {
-        unset($_SERVER['argv'][$i]);
-        $isTest = true;
-        break;
-    }
-}
-
 /** @var ContainerInterface|ServiceManager $container */
 $container = include __DIR__ . '/container.php';
-
-// If in testing env, override DB connection to use an in-memory sqlite database
-if ($isTest) {
-    $container->setAllowOverride(true);
-    $config = $container->get('config');
-    $config['entity_manager']['connection'] = [
-        'driver' => 'pdo_sqlite',
-        'path' => realpath(sys_get_temp_dir()) . '/shlink-tests.db',
-    ];
-    $container->setService('config', $config);
-}
-
-/** @var EntityManager $em */
 $em = $container->get(EntityManager::class);
 
 return ConsoleRunner::createHelperSet($em);

config/config.php

@@ -1,36 +1,28 @@
 <?php
 declare(strict_types=1);
 
+namespace Shlinkio\Shlink;
+
 use Acelaya\ExpressiveErrorHandler;
-use Shlinkio\Shlink\CLI;
-use Shlinkio\Shlink\Common;
-use Shlinkio\Shlink\Core;
-use Shlinkio\Shlink\Rest;
 use Zend\ConfigAggregator;
 use Zend\Expressive;
 
-/**
- * Configuration files are loaded in a specific order. First ``global.php``, then ``*.global.php``.
- * then ``local.php`` and finally ``*.local.php``. This way local settings overwrite global settings.
- *
- * The configuration can be cached. This can be done by setting ``config_cache_enabled`` to ``true``.
- *
- * Obviously, if you use closures in your config you can't cache it.
- */
+use function Shlinkio\Shlink\Common\env;
 
 return (new ConfigAggregator\ConfigAggregator([
     Expressive\ConfigProvider::class,
     Expressive\Router\ConfigProvider::class,
     Expressive\Router\FastRouteRouter\ConfigProvider::class,
     Expressive\Plates\ConfigProvider::class,
-    Expressive\Helper\ConfigProvider::class,
-    \class_exists(Expressive\Swoole\ConfigProvider::class)
-        ? Expressive\Swoole\ConfigProvider::class
-        : new ConfigAggregator\ArrayProvider([]),
+    Expressive\Swoole\ConfigProvider::class,
     ExpressiveErrorHandler\ConfigProvider::class,
     Common\ConfigProvider::class,
     Core\ConfigProvider::class,
     CLI\ConfigProvider::class,
     Rest\ConfigProvider::class,
-    new ConfigAggregator\ZendConfigProvider('config/{autoload/{{,*.}global,{,*.}local},params/generated_config}.php'),
+    new ConfigAggregator\PhpFileProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
+    new ConfigAggregator\ZendConfigProvider('config/params/{generated_config.php,*.config.{php,json}}'),
+    env('APP_ENV') === 'test'
+        ? new ConfigAggregator\PhpFileProvider('config/test/*.global.php')
+        : new ConfigAggregator\ArrayProvider([]),
 ], 'data/cache/app_config.php'))->getMergedConfig();

config/test/bootstrap_api_tests.php

@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\Common;
+
+use Doctrine\ORM\EntityManager;
+use Psr\Container\ContainerInterface;
+
+use function file_exists;
+use function touch;
+
+// Create an empty .env file
+if (! file_exists('.env')) {
+    touch('.env');
+}
+
+/** @var ContainerInterface $container */
+$container = require __DIR__ . '/../container.php';
+$testHelper = $container->get(TestHelper::class);
+$config = $container->get('config');
+$em = $container->get(EntityManager::class);
+
+$testHelper->createTestDb($config['entity_manager']['connection']['path']);
+ApiTest\ApiTestCase::setApiClient($container->get('shlink_test_api_client'));
+ApiTest\ApiTestCase::setSeedFixturesCallback(function () use ($testHelper, $em, $config) {
+    $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []);
+});

config/test/bootstrap_db_tests.php

@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\Common;
+
+use Psr\Container\ContainerInterface;
+
+use function file_exists;
+use function touch;
+
+// Create an empty .env file
+if (! file_exists('.env')) {
+    touch('.env');
+}
+
+/** @var ContainerInterface $container */
+$container = require __DIR__ . '/../container.php';
+$config = $container->get('config');
+
+$container->get(TestHelper::class)->createTestDb($config['entity_manager']['connection']['path']);
+DbTest\DatabaseTestCase::setEntityManager($container->get('em'));

config/test/test_config.global.php

@@ -0,0 +1,65 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink;
+
+use GuzzleHttp\Client;
+use Zend\ConfigAggregator\ConfigAggregator;
+use Zend\ServiceManager\Factory\InvokableFactory;
+
+use function sprintf;
+use function sys_get_temp_dir;
+
+$swooleTestingHost = '127.0.0.1';
+$swooleTestingPort = 9999;
+
+return [
+
+    'debug' => true,
+    ConfigAggregator::ENABLE_CACHE => false,
+
+    'url_shortener' => [
+        'domain' => [
+            'schema' => 'http',
+            'hostname' => 'doma.in',
+        ],
+    ],
+
+    'zend-expressive-swoole' => [
+        'swoole-http-server' => [
+            'host' => $swooleTestingHost,
+            'port' => $swooleTestingPort,
+            'process-name' => 'shlink_test',
+            'options' => [
+                'pid_file' => sys_get_temp_dir() . '/shlink-test-swoole.pid',
+            ],
+        ],
+    ],
+
+    'dependencies' => [
+        'services' => [
+            'shlink_test_api_client' => new Client([
+                'base_uri' => sprintf('http://%s:%s/', $swooleTestingHost, $swooleTestingPort),
+                'http_errors' => false,
+            ]),
+        ],
+        'factories' => [
+            Common\TestHelper::class => InvokableFactory::class,
+        ],
+    ],
+
+    'entity_manager' => [
+        'connection' => [
+            'driver' => 'pdo_sqlite',
+             'path' => sys_get_temp_dir() . '/shlink-tests.db',
+//            'path' => __DIR__ . '/../../data/shlink-tests.db',
+        ],
+    ],
+
+    'data_fixtures' => [
+        'paths' => [
+            __DIR__ . '/../../module/Rest/test-api/Fixtures',
+        ],
+    ],
+
+];

data/infra/database_pg/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/infra/db.Dockerfile

@@ -1,6 +0,0 @@
-FROM mysql:5.7
-MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
-
-# Enable remote access (default is localhost only, we change this
-# otherwise our database would not be reachable from outside the container)
-RUN sed -i -e"s/^bind-address\s*=\s*127.0.0.1/bind-address = 0.0.0.0/" /etc/mysql/my.cnf

data/infra/examples/apache-vhost.conf

@@ -0,0 +1,11 @@
+<VirtualHost *:80>
+    ServerName doma.in
+    DocumentRoot "/path/to/shlink/public"
+
+    <Directory "/path/to/shlink/public">
+        Options FollowSymLinks Includes ExecCGI
+        AllowOverride all
+        Order allow,deny
+        Allow from all
+    </Directory>
+</VirtualHost>

data/infra/examples/nginx-vhost.conf

@@ -0,0 +1,22 @@
+server {
+    server_name doma.in;
+    listen 80;
+    root /path/to/shlink/public;
+    index index.php;
+    charset utf-8;
+
+    location / {
+        try_files $uri $uri/ /index.php$is_args$args;
+    }
+
+    location ~ \.php$ {
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_pass unix:/var/run/php/php7.1-fpm.sock;
+        fastcgi_index index.php;
+        include fastcgi.conf;
+    }
+
+    location ~ /\.ht {
+        deny all;
+    }
+}

data/infra/examples/shlink-daemon-logrotate.conf

@@ -0,0 +1,13 @@
+/var/log/shlink/shlink_swoole.log {
+    su root root
+    daily
+    missingok
+    rotate 120
+    compress
+    delaycompress
+    notifempty
+    create 0640 root root
+    postrotate
+        /etc/init.d/shlink_swoole restart
+    endscript
+}

data/infra/examples/shlink-daemon.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+### BEGIN INIT INFO
+# Provides:          shlink_swoole
+# Required-Start:    $local_fs $network $named $time $syslog
+# Required-Stop:     $local_fs $network $named $time $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Description:       Shlink non-blocking server with swoole
+### END INIT INFO
+
+SCRIPT=/path/to/shlink/vendor/bin/zend-expressive-swoole\ start
+RUNAS=root
+
+PIDFILE=/var/run/shlink_swoole.pid
+LOGDIR=/var/log/shlink
+LOGFILE=${LOGDIR}/shlink_swoole.log
+
+start() {
+  if [[ -f "$PIDFILE" ]] && kill -0 $(cat "$PIDFILE"); then
+    echo 'Shlink with swoole already running' >&2
+    return 1
+  fi
+  echo 'Starting shlink with swoole' >&2
+  mkdir -p "$LOGDIR"
+  touch "$LOGFILE"
+  local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!"
+  su -c "$CMD" $RUNAS > "$PIDFILE"
+  echo 'Shlink started' >&2
+}
+
+stop() {
+  if [[ ! -f "$PIDFILE" ]] || ! kill -0 $(cat "$PIDFILE"); then
+    echo 'Shlink with swoole not running' >&2
+    return 1
+  fi
+  echo 'Stopping shlink with swoole' >&2
+  kill -15 $(cat "$PIDFILE") && rm -f "$PIDFILE"
+  echo 'Shlink stopped' >&2
+}
+
+case "$1" in
+  start)
+    start
+    ;;
+  stop)
+    stop
+    ;;
+  restart)
+    stop
+    start
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart}"
+esac

data/infra/nginx.Dockerfile

@@ -1,5 +0,0 @@
-FROM nginx:1.11.6-alpine
-MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
-
-# Delete default nginx vhost
-RUN rm /etc/nginx/conf.d/default.conf

data/infra/php.Dockerfile

@@ -1,6 +1,12 @@
-FROM php:7.1-fpm-alpine
+FROM php:7.3.1-fpm-alpine3.8
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
+ENV PREDIS_VERSION 4.2.0
+ENV MEMCACHED_VERSION 3.1.3
+ENV APCU_VERSION 5.1.16
+ENV APCU_BC_VERSION 1.0.4
+ENV XDEBUG_VERSION "2.7.0RC1"
+
 RUN apk update
 
 # Install common php extensions
@@ -16,17 +22,17 @@ RUN docker-php-ext-install pdo_sqlite
 RUN apk add --no-cache --virtual icu-dev
 RUN docker-php-ext-install intl
 
-RUN apk add --no-cache --virtual zlib-dev
+RUN apk add --no-cache --virtual libzip-dev zlib-dev
 RUN docker-php-ext-install zip
 
-RUN apk add --no-cache --virtual libmcrypt-dev
-RUN docker-php-ext-install mcrypt
-
 RUN apk add --no-cache --virtual libpng-dev
 RUN docker-php-ext-install gd
 
+RUN apk add --no-cache postgresql-dev
+RUN docker-php-ext-install pdo_pgsql
+
 # Install redis extension
-ADD https://github.com/phpredis/phpredis/archive/3.1.4.tar.gz /tmp/phpredis.tar.gz
+ADD https://github.com/phpredis/phpredis/archive/$PREDIS_VERSION.tar.gz /tmp/phpredis.tar.gz
 RUN mkdir -p /usr/src/php/ext/redis\
   && tar xf /tmp/phpredis.tar.gz -C /usr/src/php/ext/redis --strip-components=1
 # configure and install
@@ -38,7 +44,7 @@ RUN rm /tmp/phpredis.tar.gz
 # Install memcached extension
 RUN apk add --no-cache --virtual cyrus-sasl-dev
 RUN apk add --no-cache --virtual libmemcached-dev
-ADD https://github.com/php-memcached-dev/php-memcached/archive/php7.tar.gz /tmp/memcached.tar.gz
+ADD https://github.com/php-memcached-dev/php-memcached/archive/v$MEMCACHED_VERSION.tar.gz /tmp/memcached.tar.gz
 RUN mkdir -p /usr/src/php/ext/memcached\
   && tar xf /tmp/memcached.tar.gz -C /usr/src/php/ext/memcached --strip-components=1
 # configure and install
@@ -48,7 +54,7 @@ RUN docker-php-ext-configure memcached\
 RUN rm /tmp/memcached.tar.gz
 
 # Install APCu extension
-ADD https://pecl.php.net/get/apcu-5.1.3.tgz /tmp/apcu.tar.gz
+ADD https://pecl.php.net/get/apcu-$APCU_VERSION.tgz /tmp/apcu.tar.gz
 RUN mkdir -p /usr/src/php/ext/apcu\
   && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1
 # configure and install
@@ -58,7 +64,7 @@ RUN docker-php-ext-configure apcu\
 RUN rm /tmp/apcu.tar.gz
 
 # Install APCu-BC extension
-ADD https://pecl.php.net/get/apcu_bc-1.0.3.tgz /tmp/apcu_bc.tar.gz
+ADD https://pecl.php.net/get/apcu_bc-$APCU_BC_VERSION.tgz /tmp/apcu_bc.tar.gz
 RUN mkdir -p /usr/src/php/ext/apcu-bc\
   && tar xf /tmp/apcu_bc.tar.gz -C /usr/src/php/ext/apcu-bc --strip-components=1
 # configure and install
@@ -72,7 +78,7 @@ RUN rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini
 RUN echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
 # Install xdebug
-ADD https://pecl.php.net/get/xdebug-2.5.0 /tmp/xdebug.tar.gz
+ADD https://pecl.php.net/get/xdebug-$XDEBUG_VERSION /tmp/xdebug.tar.gz
 RUN mkdir -p /usr/src/php/ext/xdebug\
   && tar xf /tmp/xdebug.tar.gz -C /usr/src/php/ext/xdebug --strip-components=1
 # configure and install

data/infra/swoole.Dockerfile

@@ -0,0 +1,103 @@
+FROM php:7.3.1-cli-alpine3.8
+MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
+
+ENV PREDIS_VERSION 4.2.0
+ENV MEMCACHED_VERSION 3.1.3
+ENV APCU_VERSION 5.1.16
+ENV APCU_BC_VERSION 1.0.4
+
+RUN apk update
+
+# Install common php extensions
+RUN docker-php-ext-install pdo_mysql
+RUN docker-php-ext-install iconv
+RUN docker-php-ext-install mbstring
+RUN docker-php-ext-install calendar
+
+RUN apk add --no-cache --virtual sqlite-libs
+RUN apk add --no-cache --virtual sqlite-dev
+RUN docker-php-ext-install pdo_sqlite
+
+RUN apk add --no-cache --virtual icu-dev
+RUN docker-php-ext-install intl
+
+RUN apk add --no-cache --virtual libzip-dev zlib-dev
+RUN docker-php-ext-install zip
+
+RUN apk add --no-cache --virtual libpng-dev
+RUN docker-php-ext-install gd
+
+RUN apk add --no-cache postgresql-dev
+RUN docker-php-ext-install pdo_pgsql
+
+# Install redis extension
+ADD https://github.com/phpredis/phpredis/archive/$PREDIS_VERSION.tar.gz /tmp/phpredis.tar.gz
+RUN mkdir -p /usr/src/php/ext/redis\
+  && tar xf /tmp/phpredis.tar.gz -C /usr/src/php/ext/redis --strip-components=1
+# configure and install
+RUN docker-php-ext-configure redis\
+  && docker-php-ext-install redis
+# cleanup
+RUN rm /tmp/phpredis.tar.gz
+
+# Install memcached extension
+RUN apk add --no-cache --virtual cyrus-sasl-dev
+RUN apk add --no-cache --virtual libmemcached-dev
+ADD https://github.com/php-memcached-dev/php-memcached/archive/v$MEMCACHED_VERSION.tar.gz /tmp/memcached.tar.gz
+RUN mkdir -p /usr/src/php/ext/memcached\
+  && tar xf /tmp/memcached.tar.gz -C /usr/src/php/ext/memcached --strip-components=1
+# configure and install
+RUN docker-php-ext-configure memcached\
+  && docker-php-ext-install memcached
+# cleanup
+RUN rm /tmp/memcached.tar.gz
+
+# Install APCu extension
+ADD https://pecl.php.net/get/apcu-$APCU_VERSION.tgz /tmp/apcu.tar.gz
+RUN mkdir -p /usr/src/php/ext/apcu\
+  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1
+# configure and install
+RUN docker-php-ext-configure apcu\
+  && docker-php-ext-install apcu
+# cleanup
+RUN rm /tmp/apcu.tar.gz
+
+# Install APCu-BC extension
+ADD https://pecl.php.net/get/apcu_bc-$APCU_BC_VERSION.tgz /tmp/apcu_bc.tar.gz
+RUN mkdir -p /usr/src/php/ext/apcu-bc\
+  && tar xf /tmp/apcu_bc.tar.gz -C /usr/src/php/ext/apcu-bc --strip-components=1
+# configure and install
+RUN docker-php-ext-configure apcu-bc\
+  && docker-php-ext-install apcu-bc
+# cleanup
+RUN rm /tmp/apcu_bc.tar.gz
+
+# Load APCU.ini before APC.ini
+RUN rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini
+RUN echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
+
+# Install swoole
+# First line fixes an error when installing pecl extensions. Found in https://github.com/docker-library/php/issues/233
+RUN apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS && \
+    pecl install swoole && \
+    docker-php-ext-enable swoole && \
+    apk del .phpize-deps
+
+# Install composer
+RUN php -r "readfile('https://getcomposer.org/installer');" | php
+RUN chmod +x composer.phar
+RUN mv composer.phar /usr/local/bin/composer
+
+# Make home directory writable by anyone
+RUN chmod 777 /home
+
+VOLUME /home/shlink
+WORKDIR /home/shlink
+
+# Expose swoole port
+EXPOSE 8080
+
+CMD /usr/local/bin/composer update && \
+    # 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/zend-expressive-swoole start; do sleep 1 ; done

data/infra/travis-php/apcu.ini

@@ -1 +0,0 @@
-extension="apcu.so"

data/infra/travis-php/memcached.ini

@@ -1 +0,0 @@
-extension="memcached.so"

data/locks/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/migrations/Version20180913205455.php

@@ -0,0 +1,75 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+use PDO;
+use Shlinkio\Shlink\Common\Exception\WrongIpException;
+use Shlinkio\Shlink\Common\Util\IpAddress;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20180913205455 extends AbstractMigration
+{
+    /**
+     * @param Schema $schema
+     */
+    public function up(Schema $schema): void
+    {
+        // Nothing to create
+    }
+
+    /**
+     * @param Schema $schema
+     * @throws DBALException
+     */
+    public function postUp(Schema $schema): void
+    {
+        $qb = $this->connection->createQueryBuilder();
+        $qb->select('id', 'remote_addr')
+           ->from('visits');
+        $st = $this->connection->executeQuery($qb->getSQL());
+
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update('visits', 'v')
+           ->set('v.remote_addr', ':obfuscatedAddr')
+           ->where('v.id=:id');
+
+        while ($row = $st->fetch(PDO::FETCH_ASSOC)) {
+            $addr = $row['remote_addr'] ?? null;
+            if ($addr === null) {
+                continue;
+            }
+
+            $qb->setParameters([
+                'id' => $row['id'],
+                'obfuscatedAddr' => $this->determineAddress((string) $addr),
+            ])->execute();
+        }
+    }
+
+    private function determineAddress(string $addr): ?string
+    {
+        if ($addr === IpAddress::LOCALHOST) {
+            return $addr;
+        }
+
+        try {
+            return (string) IpAddress::fromString($addr)->getObfuscatedCopy();
+        } catch (WrongIpException $e) {
+            return null;
+        }
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function down(Schema $schema): void
+    {
+        // Nothing to rollback
+    }
+}

data/migrations/Version20180915110857.php

@@ -0,0 +1,50 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20180915110857 extends AbstractMigration
+{
+    private const ON_DELETE_MAP = [
+        'visit_locations' => 'SET NULL',
+        'short_urls' => 'CASCADE',
+    ];
+
+    /**
+     * @param Schema $schema
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $foreignKeys = $visits->getForeignKeys();
+
+        // Remove all existing foreign keys and add them again with CASCADE delete
+        foreach ($foreignKeys as $foreignKey) {
+            $visits->removeForeignKey($foreignKey->getName());
+            $foreignTable = $foreignKey->getForeignTableName();
+
+            $visits->addForeignKeyConstraint(
+                $foreignTable,
+                $foreignKey->getLocalColumns(),
+                $foreignKey->getForeignColumns(),
+                [
+                    'onDelete' => self::ON_DELETE_MAP[$foreignTable],
+                    'onUpdate' => 'RESTRICT',
+                ]
+            );
+        }
+    }
+
+    public function down(Schema $schema): void
+    {
+        // Nothing to run
+    }
+}

data/migrations/Version20181020060559.php

@@ -0,0 +1,68 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\DBAL\Schema\Table;
+use Doctrine\DBAL\Types\Type;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20181020060559 extends AbstractMigration
+{
+    private const COLUMNS = [
+        'countryCode' => 'country_code',
+        'countryName' => 'country_name',
+        'regionName' => 'region_name',
+        'cityName' => 'city_name',
+    ];
+
+    /**
+     * @param Schema $schema
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $this->createColumns($schema->getTable('visit_locations'), self::COLUMNS);
+    }
+
+    private function createColumns(Table $visitLocations, array $columnNames): void
+    {
+        foreach ($columnNames as $name) {
+            if (! $visitLocations->hasColumn($name)) {
+                $visitLocations->addColumn($name, Type::STRING, ['notnull' => false]);
+            }
+        }
+    }
+
+    /**
+     * @throws SchemaException
+     * @throws DBALException
+     */
+    public function postUp(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+
+        // If the camel case columns do not exist, do nothing
+        if (! $visitLocations->hasColumn('countryCode')) {
+            return;
+        }
+
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update('visit_locations');
+        foreach (self::COLUMNS as $camelCaseName => $snakeCaseName) {
+            $qb->set($snakeCaseName, $camelCaseName);
+        }
+        $qb->execute();
+    }
+
+    public function down(Schema $schema): void
+    {
+        // No down
+    }
+}

data/migrations/Version20181020065148.php

@@ -0,0 +1,40 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20181020065148 extends AbstractMigration
+{
+    private const CAMEL_CASE_COLUMNS = [
+        'countryCode',
+        'countryName',
+        'regionName',
+        'cityName',
+    ];
+
+    /**
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+
+        foreach (self::CAMEL_CASE_COLUMNS as $name) {
+            if ($visitLocations->hasColumn($name)) {
+                $visitLocations->dropColumn($name);
+            }
+        }
+    }
+
+    public function down(Schema $schema): void
+    {
+        // No down
+    }
+}

data/migrations/Version20181110175521.php

@@ -0,0 +1,36 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Column;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20181110175521 extends AbstractMigration
+{
+    /**
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $this->getUserAgentColumn($schema)->setLength(512);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    public function down(Schema $schema): void
+    {
+        $this->getUserAgentColumn($schema)->setLength(256);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    private function getUserAgentColumn(Schema $schema): Column
+    {
+        return $schema->getTable('visits')->getColumn('user_agent');
+    }
+}

data/migrations_template.txt

@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+namespace <namespace>;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version<version> extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+<up>
+    }
+
+    public function down(Schema $schema): void
+    {
+<down>
+    }
+}

data/travis/trigger_docker_build.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -e
+
+# Get latest commit in master, in plain text
+LATEST_MASTER_COMMIT=$(curl -H "Accept: application/vnd.github.sha" -X GET https://api.github.com/repos/shlinkio/shlink-docker-image/commits/master)
+
+# Create new tag and a ref to the tag, which will trigger image build on it
+curl -u acelaya:${GITHUB_OAUTH_KEY} \
+    -H "Content-Type: application/json" \
+    --data "{ \"tag\": \"${TRAVIS_TAG}\", \"message\": \"${TRAVIS_TAG}\", \"object\": \"${LATEST_MASTER_COMMIT}\", \"type\": \"commit\" }" \
+    -X POST https://api.github.com/repos/shlinkio/shlink-docker-image/git/tags
+curl -u acelaya:${GITHUB_OAUTH_KEY} \
+    -H "Content-Type: application/json" \
+    --data "{ \"ref\": \"refs/tags/${TRAVIS_TAG}\", \"sha\": \"${LATEST_MASTER_COMMIT}\" }" \
+    -X POST https://api.github.com/repos/shlinkio/shlink-docker-image/git/refs
+
+# Trigger image build for "latest
+curl -H "Content-Type: application/json" \
+    --data '{ "docker_tag": "latest" }' \
+    -X POST https://registry.hub.docker.com/u/shlinkio/shlink/trigger/${DOCKER_TRIGGER_TOKEN}/

docker-compose.override.yml.dist

@@ -1,4 +1,4 @@
-version: '2'
+version: '3'
 
 services:
     shlink_php:
@@ -6,3 +6,21 @@ services:
         volumes:
             - /etc/passwd:/etc/passwd:ro
             - /etc/group:/etc/group:ro
+
+    shlink_swoole:
+        user: 1000:1000
+        volumes:
+            - /etc/passwd:/etc/passwd:ro
+            - /etc/group:/etc/group:ro
+
+    shlink_db:
+        user: 1000:1000
+        volumes:
+            - /etc/passwd:/etc/passwd:ro
+            - /etc/group:/etc/group:ro
+
+    shlink_db_postgres:
+        user: 1000:1000
+        volumes:
+            - /etc/passwd:/etc/passwd:ro
+            - /etc/group:/etc/group:ro

docker-compose.yml

@@ -1,17 +1,15 @@
-version: '2'
+version: '3'
 
 services:
     shlink_nginx:
         container_name: shlink_nginx
-        build:
-            context: .
-            dockerfile: ./data/infra/nginx.Dockerfile
+        image: nginx:1.15.9-alpine
         ports:
             - "8000:80"
         volumes:
             - ./:/home/shlink/www
             - ./docs:/home/shlink/www/public/docs
-            - ./data/infra/vhost.conf:/etc/nginx/conf.d/shlink-vhost.conf
+            - ./data/infra/vhost.conf:/etc/nginx/conf.d/default.conf
         links:
             - shlink_php
 
@@ -25,12 +23,24 @@ services:
             - ./data/infra/php.ini:/usr/local/etc/php/php.ini
         links:
             - shlink_db
+            - shlink_db_postgres
+
+    shlink_swoole:
+        container_name: shlink_swoole
+        build:
+            context: .
+            dockerfile: ./data/infra/swoole.Dockerfile
+        ports:
+            - "8080:8080"
+        volumes:
+            - ./:/home/shlink
+        links:
+            - shlink_db
+            - shlink_db_postgres
 
     shlink_db:
         container_name: shlink_db
-        build:
-            context: .
-            dockerfile: ./data/infra/db.Dockerfile
+        image: mysql:5.7
         ports:
             - "3307:3306"
         volumes:
@@ -39,3 +49,16 @@ services:
         environment:
             MYSQL_ROOT_PASSWORD: root
             MYSQL_DATABASE: shlink
+
+    shlink_db_postgres:
+        container_name: shlink_db_postgres
+        image: postgres:10.7-alpine
+        ports:
+            - "5433:5432"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/database_pg:/var/lib/postgresql/data
+        environment:
+            POSTGRES_PASSWORD: root
+            POSTGRES_DB: shlink
+            PGDATA: /var/lib/postgresql/data/pgdata

docs/swagger/definitions/Health.json

@@ -0,0 +1,31 @@
+{
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "pass",
+                "fail"
+            ],
+            "description": "The status of the service"
+        },
+        "version": {
+            "type": "string",
+            "description": "Shlink version"
+        },
+        "links": {
+            "type": "object",
+            "properties": {
+                "about": {
+                    "type": "string",
+                    "description": "About shlink"
+                },
+                "project": {
+                    "type": "string",
+                    "description": "Shlink project repository"
+                }
+            },
+            "description": "A list of links"
+        }
+    }
+}

docs/swagger/definitions/ShortUrl.json

@@ -5,7 +5,11 @@
             "type": "string",
             "description": "The short code for this short URL."
         },
-        "originalUrl": {
+        "shortUrl": {
+            "type": "string",
+            "description": "The short URL."
+        },
+        "longUrl": {
             "type": "string",
             "description": "The original long URL."
         },
@@ -24,6 +28,11 @@
                 "type": "string"
             },
             "description": "A list of tags applied to this short URL"
+        },
+        "originalUrl": {
+            "deprecated": true,
+            "type": "string",
+            "description": "The original long URL. [DEPRECATED. Use longUrl instead]"
         }
     }
 }

docs/swagger/definitions/Visit.json

@@ -2,17 +2,25 @@
     "type": "object",
     "properties": {
         "referer": {
-            "type": "string"
+            "type": "string",
+            "description": "The origin from which the visit was performed"
         },
         "date": {
             "type": "string",
-            "format": "date-time"
-        },
-        "remoteAddr": {
-            "type": "string"
+            "format": "date-time",
+            "description": "The date in which the visit was performed"
         },
         "userAgent": {
-            "type": "string"
+            "type": "string",
+            "description": "The user agent from which the visit was performed"
+        },
+        "visitLocation": {
+            "$ref": "./VisitLocation.json"
+        },
+        "remoteAddr": {
+            "type": "string",
+            "description": "This value is deprecated and will always be null",
+            "deprecated": true
         }
     }
 }

docs/swagger/definitions/VisitLocation.json

@@ -0,0 +1,26 @@
+{
+    "type": "object",
+    "properties": {
+        "cityName": {
+            "type": "string"
+        },
+        "countryCode": {
+            "type": "string"
+        },
+        "countryName": {
+            "type": "string"
+        },
+        "latitude": {
+            "type": "string"
+        },
+        "longitude": {
+            "type": "string"
+        },
+        "regionName": {
+            "type": "string"
+        },
+        "timezone": {
+            "type": "string"
+        }
+    }
+}

docs/swagger/paths/health.json

@@ -0,0 +1,62 @@
+{
+    "get": {
+        "operationId": "health",
+        "tags": [
+            "Monitoring"
+        ],
+        "summary": "Check healthiness",
+        "description": "Checks the healthiness of the service, making sure it can access required resources.",
+        "responses": {
+            "200": {
+                "description": "The passing health status",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Health.json"
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "status": "pass",
+                        "version": "1.16.0",
+                        "links": {
+                            "about": "https://shlink.io",
+                            "project": "https://github.com/shlinkio/shlink"
+                        }
+                    }
+                }
+            },
+            "503": {
+                "description": "The failing health status",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Health.json"
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "status": "fail",
+                        "version": "1.16.0",
+                        "links": {
+                            "about": "https://shlink.io",
+                            "project": "https://github.com/shlinkio/shlink"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/v1_authenticate.json

@@ -1,10 +1,12 @@
 {
     "post": {
+        "deprecated": true,
+        "operationId": "authenticate",
         "tags": [
             "Authentication"
         ],
-        "summary": "Perform authentication",
-        "description": "Performs an authentication",
+        "summary": "[Deprecated] Perform authentication",
+        "description": "**This endpoint is deprecated, since the authentication can be performed via API key now**. Performs an authentication.",
         "requestBody": {
             "description": "Request body.",
             "required": true,

docs/swagger/paths/v1_short-urls.json

@@ -1,10 +1,11 @@
 {
     "get": {
+        "operationId": "listShortUrls",
         "tags": [
-            "ShortCodes"
+            "Short URLs"
         ],
         "summary": "List short URLs",
-        "description": "Returns the list of short codes",
+        "description": "Returns the list of short URLs.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
         "parameters": [
             {
                 "name": "page",
@@ -44,7 +45,7 @@
                 "schema": {
                     "type": "string",
                     "enum": [
-                        "originalUrl",
+                        "longUrl",
                         "shortCode",
                         "dateCreated",
                         "visits"
@@ -53,6 +54,9 @@
             }
         ],
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }
@@ -89,7 +93,8 @@
                             "data": [
                                 {
                                     "shortCode": "12C18",
-                                    "originalUrl": "https://store.steampowered.com",
+                                    "shortUrl": "https://doma.in/12C18",
+                                    "longUrl": "https://store.steampowered.com",
                                     "dateCreated": "2016-08-21T20:34:16+02:00",
                                     "visitsCount": 328,
                                     "tags": [
@@ -99,7 +104,8 @@
                                 },
                                 {
                                     "shortCode": "12Kb3",
-                                    "originalUrl": "https://shlink.io",
+                                    "shortUrl": "https://doma.in/12Kb3",
+                                    "longUrl": "https://shlink.io",
                                     "dateCreated": "2016-05-01T20:34:16+02:00",
                                     "visitsCount": 1029,
                                     "tags": [
@@ -108,7 +114,8 @@
                                 },
                                 {
                                     "shortCode": "123bA",
-                                    "originalUrl": "https://www.google.com",
+                                    "shortUrl": "https://doma.in/123bA",
+                                    "longUrl": "https://www.google.com",
                                     "dateCreated": "2015-10-01T20:34:16+02:00",
                                     "visitsCount": 25,
                                     "tags": []
@@ -139,12 +146,16 @@
     },
 
     "post": {
+        "operationId": "createShortUrl",
         "tags": [
-            "ShortCodes"
+            "Short URLs"
         ],
         "summary": "Create short URL",
-        "description": "Creates a new short code",
+        "description": "Creates a new short URL.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.<br></br>**Param findIfExists:**: Starting with v1.16, this new param allows to force shlink to return existing short URLs when found based on provided params, instead of creating a new one. However, it might add complexity and have unexpected outputs.\n\nThese are the use cases:\n* Only the long URL is provided: It will return the newest match or create a new short URL if none is found.\n* Long url and custom slug are provided: It will return the short URL when both params match, return an error when the slug is in use for another long URL, or create a new short URL otherwise.\n* Any of the above but including other params (tags, validSince, validUntil, maxVisits): It will behave the same as the previous two cases, but it will try to exactly match existing results using all the params. If any of them does not match, it will try to create a new short URL.",
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }
@@ -186,6 +197,10 @@
                             "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"
                             }
                         }
                     }
@@ -198,23 +213,22 @@
                 "content": {
                     "application/json": {
                         "schema": {
-                            "type": "object",
-                            "properties": {
-                                "longUrl": {
-                                    "type": "string",
-                                    "description": "The original long URL that has been parsed"
-                                },
-                                "shortUrl": {
-                                    "type": "string",
-                                    "description": "The generated short URL"
-                                },
-                                "shortCode": {
-                                    "type": "string",
-                                    "description": "the short code that is being used in the short URL"
-                                }
-                            }
+                            "$ref": "../definitions/ShortUrl.json"
                         }
                     }
+                },
+                "examples": {
+                    "application/json": {
+                        "shortCode": "12C18",
+                        "shortUrl": "https://doma.in/12C18",
+                        "longUrl": "https://store.steampowered.com",
+                        "dateCreated": "2016-08-21T20:34:16+02:00",
+                        "visitsCount": 0,
+                        "tags": [
+                            "games",
+                            "tech"
+                        ]
+                    }
                 }
             },
             "400": {

docs/swagger/paths/v1_short-urls_shorten.json

@@ -1,10 +1,11 @@
 {
     "get": {
+        "operationId": "shortenUrl",
         "tags": [
-            "ShortCodes"
+            "Short URLs"
         ],
         "summary": "Create a short URL",
-        "description": "Creates a short URL in a single API call. Useful for third party integrations",
+        "description": "Creates a short URL in a single API call. Useful for third party integrations.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
         "parameters": [
             {
                 "name": "apiKey",
@@ -44,21 +45,7 @@
                 "content": {
                     "application/json": {
                         "schema": {
-                            "type": "object",
-                            "properties": {
-                                "longUrl": {
-                                    "type": "string",
-                                    "description": "The original long URL that has been shortened"
-                                },
-                                "shortUrl": {
-                                    "type": "string",
-                                    "description": "The generated short URL"
-                                },
-                                "shortCode": {
-                                    "type": "string",
-                                    "description": "the short code that is being used in the short URL"
-                                }
-                            }
+                            "$ref": "../definitions/ShortUrl.json"
                         }
                     },
                     "text/plain": {
@@ -70,10 +57,16 @@
                 "examples": {
                     "application/json": {
                         "longUrl": "https://github.com/shlinkio/shlink",
-                        "shortUrl": "https://dom.ain/abc123",
-                        "shortCode": "abc123"
+                        "shortUrl": "https://doma.in/abc123",
+                        "shortCode": "abc123",
+                        "dateCreated": "2016-08-21T20:34:16+02:00",
+                        "visitsCount": 0,
+                        "tags": [
+                            "games",
+                            "tech"
+                        ]
                     },
-                    "text/plain": "https://dom.ain/abc123"
+                    "text/plain": "https://doma.in/abc123"
                 }
             },
             "400": {

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

@@ -1,10 +1,11 @@
 {
     "get": {
+        "operationId": "getShortUrl",
         "tags": [
-            "ShortCodes"
+            "Short URLs"
         ],
         "summary": "Parse short code",
-        "description": "Get the long URL behind a short code.",
+        "description": "Get the long URL behind a short URL's short code.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
         "parameters": [
             {
                 "name": "shortCode",
@@ -17,29 +18,33 @@
             }
         ],
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }
         ],
         "responses": {
             "200": {
-                "description": "The long URL behind a short code.",
+                "description": "The URL info behind a short code.",
                 "content": {
                     "application/json": {
                         "schema": {
-                            "type": "object",
-                            "properties": {
-                                "longUrl": {
-                                    "type": "string",
-                                    "description": "The original long URL behind the short code."
-                                }
-                            }
+                            "$ref": "../definitions/ShortUrl.json"
                         }
                     }
                 },
                 "examples": {
                     "application/json": {
-                        "longUrl": "https://shlink.io"
+                        "shortCode": "12Kb3",
+                        "shortUrl": "https://doma.in/12Kb3",
+                        "longUrl": "https://shlink.io",
+                        "dateCreated": "2016-05-01T20:34:16+02:00",
+                        "visitsCount": 1029,
+                        "tags": [
+                            "shlink"
+                        ]
                     }
                 }
             },
@@ -77,11 +82,12 @@
     },
 
     "put": {
+        "operationId": "editShortUrl",
         "tags": [
-            "ShortCodes"
+            "Short URLs"
         ],
-        "summary": "Edit short code",
-        "description": "Update certain meta arguments from an existing short URL.",
+        "summary": "Edit short URL",
+        "description": "Update certain meta arguments from an existing short URL.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
         "parameters": [
             {
                 "name": "shortCode",
@@ -119,6 +125,9 @@
             }
         },
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }
@@ -158,5 +167,74 @@
                 }
             }
         }
+    },
+
+    "delete": {
+        "operationId": "deleteShortUrl",
+        "tags": [
+            "Short URLs"
+        ],
+        "summary": "Delete short URL",
+        "description": "Deletes the short URL for provided short code.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to edit.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "security": [
+            {
+                "ApiKey": []
+            },
+            {
+                "Bearer": []
+            }
+        ],
+        "responses": {
+            "204": {
+                "description": "The short URL has been properly deleted."
+            },
+            "400": {
+                "description": "The visits threshold in shlink does not allow this short URL to be deleted.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "error": "INVALID_SHORTCODE_DELETION",
+                        "message": "It is not possible to delete URL with short code \"abc123\" because it has reached more than \"15\" visits."
+                    }
+                }
+            },
+            "404": {
+                "description": "No short URL was found for provided short code.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
     }
 }

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

@@ -1,16 +1,16 @@
 {
     "put": {
+        "operationId": "editShortUrlTags",
         "tags": [
-            "ShortCodes",
-            "Tags"
+            "Short URLs"
         ],
         "summary": "Edit tags on short URL",
-        "description": "Edit the tags on provided short code.",
+        "description": "Edit the tags on URL identified by provided short code.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
         "parameters": [
             {
                 "name": "shortCode",
                 "in": "path",
-                "description": "The shortCode in which we want to edit tags.",
+                "description": "The short code for the short URL in which we want to edit tags.",
                 "required": true,
                 "schema": {
                     "type": "string"
@@ -41,6 +41,9 @@
             }
         },
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }

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

@@ -1,16 +1,16 @@
 {
     "get": {
+        "operationId": "getShortUrlVisits",
         "tags": [
-            "ShortCodes",
             "Visits"
         ],
         "summary": "List visits for short URL",
-        "description": "Get the list of visits on provided short code.",
+        "description": "Get the list of visits on the short URL behind provided short code.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
         "parameters": [
             {
                 "name": "shortCode",
                 "in": "path",
-                "description": "The shortCode from which we want to get the visits.",
+                "description": "The short code for the short URL from which we want to get the visits.",
                 "required": true,
                 "schema": {
                     "type": "string"
@@ -33,9 +33,30 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "name": "page",
+                "in": "query",
+                "description": "The page to display. Defaults to 1",
+                "required": false,
+                "schema": {
+                    "type": "number"
+                }
+            },
+            {
+                "name": "itemsPerPage",
+                "in": "query",
+                "description": "The amount of items to return on every page. Defaults to all the items",
+                "required": false,
+                "schema": {
+                    "type": "number"
+                }
             }
         ],
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }
@@ -56,6 +77,9 @@
                                             "items": {
                                                 "$ref": "../definitions/Visit.json"
                                             }
+                                        },
+                                        "pagination": {
+                                            "$ref": "../definitions/Pagination.json"
                                         }
                                     }
                                 }
@@ -70,22 +94,37 @@
                                 {
                                     "referer": "https://twitter.com",
                                     "date": "2015-08-20T05:05:03+04:00",
-                                    "remoteAddr": "10.20.30.40",
-                                    "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"
+                                    "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
                                 },
                                 {
                                     "referer": "https://t.co",
                                     "date": "2015-08-20T05:05:03+04:00",
-                                    "remoteAddr": "11.22.33.44",
-                                    "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36"
+                                    "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
+                                    "visitLocation": {
+                                        "cityName": "Cupertino",
+                                        "countryCode": "US",
+                                        "countryName": "United States",
+                                        "latitude": "37.3042",
+                                        "longitude": "-122.0946",
+                                        "regionName": "California",
+                                        "timezone": "America/Los_Angeles"
+                                    }
                                 },
                                 {
                                     "referer": null,
                                     "date": "2015-08-20T05:05:03+04:00",
-                                    "remoteAddr": "110.220.5.6",
-                                    "userAgent": "some_web_crawler/1.4"
+                                    "userAgent": "some_web_crawler/1.4",
+                                    "visitLocation": null
                                 }
-                            ]
+                            ],
+                            "pagination": {
+                                "currentPage": 5,
+                                "pagesCount": 12,
+                                "itemsPerPage": 10,
+                                "itemsInCurrentPage": 10,
+                                "totalItems": 115
+                            }
                         }
                     }
                 }

docs/swagger/paths/v1_tags.json

@@ -1,11 +1,15 @@
 {
     "get": {
+        "operationId": "listTags",
         "tags": [
             "Tags"
         ],
         "summary": "List existing tags",
         "description": "Returns the list of all tags used in any short URL, ordered by name",
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }
@@ -60,12 +64,16 @@
     },
 
     "post": {
+        "operationId": "createTags",
         "tags": [
             "Tags"
         ],
         "summary": "Create tags",
         "description": "Provided a list of tags, creates all that do not yet exist",
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }
@@ -143,12 +151,16 @@
     },
 
     "put": {
+        "operationId": "renameTag",
         "tags": [
             "Tags"
         ],
         "summary": "Rename tag",
         "description": "Renames one existing tag",
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }
@@ -216,6 +228,7 @@
     },
 
     "delete": {
+        "operationId": "deleteTags",
         "tags": [
             "Tags"
         ],
@@ -236,6 +249,9 @@
             }
         ],
         "security": [
+            {
+                "ApiKey": []
+            },
             {
                 "Bearer": []
             }

docs/swagger/paths/{shortCode}.json

@@ -0,0 +1,36 @@
+{
+    "get": {
+        "operationId": "shortUrl",
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL",
+        "description": "Represents a short URL. Tracks the visit and redirects tio the corresponding long URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "responses": {
+            "302": {
+                "description": "Visit properly tracked and redirected"
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/{shortCode}_preview.json

@@ -0,0 +1,44 @@
+{
+    "get": {
+        "operationId": "shortUrlPreview",
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL preview image",
+        "description": "Returns the preview of the page behind a short URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Image in PNG format",
+                "content": {
+                    "image/png": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

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

@@ -0,0 +1,56 @@
+{
+    "get": {
+        "operationId": "shortUrlQrCode",
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL QR code",
+        "description": "Generates a QR code image pointing to a short URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            },
+            {
+                "name": "size",
+                "in": "path",
+                "description": "The size of the image to be returned.",
+                "required": false,
+                "schema": {
+                    "type": "integer",
+                    "minimum": 50,
+                    "maximum": 1000,
+                    "default": 300
+                }
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "QR code in PNG format",
+                "content": {
+                    "image/png": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/{shortCode}_track.json

@@ -0,0 +1,44 @@
+{
+    "get": {
+        "operationId": "trackShortUrl",
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL tracking pixel",
+        "description": "Generates a 1px transparent image which can be used to track emails with a short URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Image in GIF format",
+                "content": {
+                    "image/gif": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/swagger.json

@@ -6,15 +6,20 @@
         "version": "1.0"
     },
 
+    "externalDocs": {
+        "url": "https://shlink.io/api-docs",
+        "description": "Find more info on how to start using this API here"
+    },
+
     "servers": [
         {
-            "url": "{schema}://{server}/rest",
+            "url": "{scheme}://{host}",
             "variables": {
-                "schema": {
+                "scheme": {
                     "default": "https",
                     "enum": ["https", "http"]
                 },
-                "server": {
+                "host": {
                     "default": ""
                 }
             }
@@ -23,8 +28,14 @@
 
     "components": {
         "securitySchemes": {
+            "ApiKey": {
+                "description": "A valid shlink API key",
+                "type": "apiKey",
+                "in": "header",
+                "name": "X-Api-Key"
+            },
             "Bearer": {
-                "description": "The JWT identifying a previously logged API key",
+                "description": "**[Deprecated]** The JWT identifying a previously authenticated API key",
                 "type": "http",
                 "scheme": "bearer",
                 "bearerFormat": "JWT"
@@ -32,30 +43,74 @@
         }
     },
 
+    "tags": [
+        {
+            "name": "Short URLs",
+            "description": "Operations that can be performed on short URLs"
+        },
+        {
+            "name": "Tags",
+            "description": "Let you handle the list of available tags"
+        },
+        {
+            "name": "Visits",
+            "description": "Operations to manage visits on short URLs"
+        },
+        {
+            "name": "Monitoring",
+            "description": "Public endpoints designed to monitor the service"
+        },
+        {
+            "name": "URL Shortener",
+            "description": "Non-rest endpoints, used to be publicly exposed"
+        },
+        {
+            "name": "Authentication",
+            "description": "**[Deprecated]** Authentication-related endpoints"
+        }
+    ],
+
     "paths": {
-        "/v1/authenticate": {
-            "$ref": "paths/v1_authenticate.json"
+        "/rest/v1/short-urls": {
+            "$ref": "paths/v1_short-urls.json"
+        },
+        "/rest/v1/short-urls/shorten": {
+            "$ref": "paths/v1_short-urls_shorten.json"
+        },
+        "/rest/v1/short-urls/{shortCode}": {
+            "$ref": "paths/v1_short-urls_{shortCode}.json"
+        },
+        "/rest/v1/short-urls/{shortCode}/tags": {
+            "$ref": "paths/v1_short-urls_{shortCode}_tags.json"
         },
 
-        "/v1/short-codes": {
-            "$ref": "paths/v1_short-codes.json"
-        },
-        "/v1/short-codes/shorten": {
-            "$ref": "paths/v1_short-codes_shorten.json"
-        },
-        "/v1/short-codes/{shortCode}": {
-            "$ref": "paths/v1_short-codes_{shortCode}.json"
-        },
-        "/v1/short-codes/{shortCode}/tags": {
-            "$ref": "paths/v1_short-codes_{shortCode}_tags.json"
-        },
-
-        "/v1/tags": {
+        "/rest/v1/tags": {
             "$ref": "paths/v1_tags.json"
         },
 
-        "/v1/short-codes/{shortCode}/visits": {
-            "$ref": "paths/v1_short-codes_{shortCode}_visits.json"
+        "/rest/v1/short-urls/{shortCode}/visits": {
+            "$ref": "paths/v1_short-urls_{shortCode}_visits.json"
+        },
+
+        "/rest/health": {
+            "$ref": "paths/health.json"
+        },
+
+        "/{shortCode}": {
+            "$ref": "paths/{shortCode}.json"
+        },
+        "/{shortCode}/track": {
+            "$ref": "paths/{shortCode}_track.json"
+        },
+        "/{shortCode}/qr-code": {
+            "$ref": "paths/{shortCode}_qr-code.json"
+        },
+        "/{shortCode}/preview": {
+            "$ref": "paths/{shortCode}_preview.json"
+        },
+
+        "/rest/v1/authenticate": {
+            "$ref": "paths/v1_authenticate.json"
         }
     }
 }

func_tests_bootstrap.php

@@ -1,33 +0,0 @@
-<?php
-declare(strict_types=1);
-
-use ShlinkioTest\Shlink\Common\DbUnit\DatabaseTestCase;
-use Symfony\Component\Process\Process;
-use Zend\ServiceManager\ServiceManager;
-
-// Create an empty .env file
-if (! file_exists('.env')) {
-    touch('.env');
-}
-
-$shlinkDbPath = realpath(sys_get_temp_dir()) . '/shlink-tests.db';
-if (file_exists($shlinkDbPath)) {
-    unlink($shlinkDbPath);
-}
-
-/** @var ServiceManager $sm */
-$sm = require __DIR__ . '/config/container.php';
-$sm->setAllowOverride(true);
-$config = $sm->get('config');
-$config['entity_manager']['connection'] = [
-    'driver' => 'pdo_sqlite',
-    'path' => $shlinkDbPath,
-];
-$sm->setService('config', $config);
-
-// Create database
-$process = new Process('vendor/bin/doctrine orm:schema-tool:create --no-interaction -q --test', __DIR__);
-$process->inheritEnvironmentVariables()
-        ->mustRun();
-
-DatabaseTestCase::$em = $sm->get('em');

indocker

@@ -1,2 +1,8 @@
 #!/usr/bin/env bash
-docker exec -it shlink_php /bin/sh -c "cd /home/shlink/www && $*"
+
+# Run docker containers if they are not up yet
+if ! [[ $(docker ps | grep shlink_swoole) ]]; then
+    docker-compose up -d
+fi
+
+docker exec -it shlink_swoole /bin/sh -c "$*"

infection.json

@@ -2,10 +2,9 @@
     "source": {
         "directories": [
             "module/*/src"
-        ],
-        "excludes": []
+        ]
     },
-    "timeout": 10,
+    "timeout": 5,
     "logs": {
         "text": "build/infection/infection-log.txt",
         "summary": "build/infection/summary-log.txt",
@@ -17,6 +16,7 @@
     },
     "mutators": {
         "@default": true,
-        "IdenticalEqual": false
+        "IdenticalEqual": false,
+        "NotIdenticalNotEqual": false
     }
 }

migrations.yml

@@ -2,3 +2,4 @@ name: ShlinkMigrations
 migrations_namespace: ShlinkMigrations
 table_name: migrations
 migrations_directory: data/migrations
+custom_template: data/migrations_template.txt

module/CLI/config/cli.config.php

@@ -1,21 +1,21 @@
 <?php
 declare(strict_types=1);
 
-use Shlinkio\Shlink\CLI\Command;
-use Shlinkio\Shlink\Common;
+namespace Shlinkio\Shlink\CLI;
 
 return [
 
     'cli' => [
-        'locale' => Common\env('CLI_LOCALE', 'en'),
         'commands' => [
-            Command\Shortcode\GenerateShortcodeCommand::NAME => Command\Shortcode\GenerateShortcodeCommand::class,
-            Command\Shortcode\ResolveUrlCommand::NAME => Command\Shortcode\ResolveUrlCommand::class,
-            Command\Shortcode\ListShortcodesCommand::NAME => Command\Shortcode\ListShortcodesCommand::class,
-            Command\Shortcode\GetVisitsCommand::NAME => Command\Shortcode\GetVisitsCommand::class,
-            Command\Shortcode\GeneratePreviewCommand::NAME => Command\Shortcode\GeneratePreviewCommand::class,
+            Command\ShortUrl\GenerateShortUrlCommand::NAME => Command\ShortUrl\GenerateShortUrlCommand::class,
+            Command\ShortUrl\ResolveUrlCommand::NAME => Command\ShortUrl\ResolveUrlCommand::class,
+            Command\ShortUrl\ListShortUrlsCommand::NAME => Command\ShortUrl\ListShortUrlsCommand::class,
+            Command\ShortUrl\GetVisitsCommand::NAME => Command\ShortUrl\GetVisitsCommand::class,
+            Command\ShortUrl\GeneratePreviewCommand::NAME => Command\ShortUrl\GeneratePreviewCommand::class,
+            Command\ShortUrl\DeleteShortUrlCommand::NAME => Command\ShortUrl\DeleteShortUrlCommand::class,
 
             Command\Visit\ProcessVisitsCommand::NAME => Command\Visit\ProcessVisitsCommand::class,
+            Command\Visit\UpdateDbCommand::NAME => Command\Visit\UpdateDbCommand::class,
 
             Command\Config\GenerateCharsetCommand::NAME => Command\Config\GenerateCharsetCommand::class,
             Command\Config\GenerateSecretCommand::NAME => Command\Config\GenerateSecretCommand::class,

module/CLI/config/dependencies.config.php

@@ -1,33 +1,41 @@
 <?php
 declare(strict_types=1);
 
-use Shlinkio\Shlink\CLI\Command;
-use Shlinkio\Shlink\CLI\Factory\ApplicationFactory;
-use Shlinkio\Shlink\Common\Service\IpApiLocationResolver;
+namespace Shlinkio\Shlink\CLI;
+
+use Shlinkio\Shlink\Common\IpGeolocation\GeoLite2\DbUpdater;
+use Shlinkio\Shlink\Common\IpGeolocation\IpLocationResolverInterface;
 use Shlinkio\Shlink\Common\Service\PreviewGenerator;
 use Shlinkio\Shlink\Core\Service;
 use Shlinkio\Shlink\Rest\Service\ApiKeyService;
 use Symfony\Component\Console\Application;
-use Zend\I18n\Translator\Translator;
+use Symfony\Component\Lock;
 use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Zend\ServiceManager\Factory\InvokableFactory;
 
 return [
 
     'dependencies' => [
         'factories' => [
-            Application::class => ApplicationFactory::class,
+            Application::class => Factory\ApplicationFactory::class,
+
+            Command\ShortUrl\GenerateShortUrlCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\ResolveUrlCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\ListShortUrlsCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\GetVisitsCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\GeneratePreviewCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\DeleteShortUrlCommand::class => ConfigAbstractFactory::class,
 
-            Command\Shortcode\GenerateShortcodeCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\ResolveUrlCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\ListShortcodesCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\GetVisitsCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\GeneratePreviewCommand::class => ConfigAbstractFactory::class,
             Command\Visit\ProcessVisitsCommand::class => ConfigAbstractFactory::class,
-            Command\Config\GenerateCharsetCommand::class => ConfigAbstractFactory::class,
-            Command\Config\GenerateSecretCommand::class => ConfigAbstractFactory::class,
+            Command\Visit\UpdateDbCommand::class => ConfigAbstractFactory::class,
+
+            Command\Config\GenerateCharsetCommand::class => InvokableFactory::class,
+            Command\Config\GenerateSecretCommand::class => InvokableFactory::class,
+
             Command\Api\GenerateKeyCommand::class => ConfigAbstractFactory::class,
             Command\Api\DisableKeyCommand::class => ConfigAbstractFactory::class,
             Command\Api\ListKeysCommand::class => ConfigAbstractFactory::class,
+
             Command\Tag\ListTagsCommand::class => ConfigAbstractFactory::class,
             Command\Tag\CreateTagCommand::class => ConfigAbstractFactory::class,
             Command\Tag\RenameTagCommand::class => ConfigAbstractFactory::class,
@@ -36,33 +44,28 @@ return [
     ],
 
     ConfigAbstractFactory::class => [
-        Command\Shortcode\GenerateShortcodeCommand::class => [
-            Service\UrlShortener::class,
-            'translator',
-            'config.url_shortener.domain',
-        ],
-        Command\Shortcode\ResolveUrlCommand::class => [Service\UrlShortener::class, 'translator'],
-        Command\Shortcode\ListShortcodesCommand::class => [Service\ShortUrlService::class, 'translator'],
-        Command\Shortcode\GetVisitsCommand::class => [Service\VisitsTracker::class, 'translator'],
-        Command\Shortcode\GeneratePreviewCommand::class => [
-            Service\ShortUrlService::class,
-            PreviewGenerator::class,
-            'translator',
-        ],
+        Command\ShortUrl\GenerateShortUrlCommand::class => [Service\UrlShortener::class, 'config.url_shortener.domain'],
+        Command\ShortUrl\ResolveUrlCommand::class => [Service\UrlShortener::class],
+        Command\ShortUrl\ListShortUrlsCommand::class => [Service\ShortUrlService::class, 'config.url_shortener.domain'],
+        Command\ShortUrl\GetVisitsCommand::class => [Service\VisitsTracker::class],
+        Command\ShortUrl\GeneratePreviewCommand::class => [Service\ShortUrlService::class, PreviewGenerator::class],
+        Command\ShortUrl\DeleteShortUrlCommand::class => [Service\ShortUrl\DeleteShortUrlService::class],
+
         Command\Visit\ProcessVisitsCommand::class => [
             Service\VisitService::class,
-            IpApiLocationResolver::class,
-            'translator',
+            IpLocationResolverInterface::class,
+            Lock\Factory::class,
         ],
-        Command\Config\GenerateCharsetCommand::class => ['translator'],
-        Command\Config\GenerateSecretCommand::class => ['translator'],
-        Command\Api\GenerateKeyCommand::class => [ApiKeyService::class, 'translator'],
-        Command\Api\DisableKeyCommand::class => [ApiKeyService::class, 'translator'],
-        Command\Api\ListKeysCommand::class => [ApiKeyService::class, 'translator'],
-        Command\Tag\ListTagsCommand::class => [Service\Tag\TagService::class, Translator::class],
-        Command\Tag\CreateTagCommand::class => [Service\Tag\TagService::class, Translator::class],
-        Command\Tag\RenameTagCommand::class => [Service\Tag\TagService::class, Translator::class],
-        Command\Tag\DeleteTagsCommand::class => [Service\Tag\TagService::class, Translator::class],
+        Command\Visit\UpdateDbCommand::class => [DbUpdater::class],
+
+        Command\Api\GenerateKeyCommand::class => [ApiKeyService::class],
+        Command\Api\DisableKeyCommand::class => [ApiKeyService::class],
+        Command\Api\ListKeysCommand::class => [ApiKeyService::class],
+
+        Command\Tag\ListTagsCommand::class => [Service\Tag\TagService::class],
+        Command\Tag\CreateTagCommand::class => [Service\Tag\TagService::class],
+        Command\Tag\RenameTagCommand::class => [Service\Tag\TagService::class],
+        Command\Tag\DeleteTagsCommand::class => [Service\Tag\TagService::class],
     ],
 
 ];

module/CLI/config/translator.config.php

@@ -1,16 +0,0 @@
-<?php
-declare(strict_types=1);
-
-return [
-
-    'translator' => [
-        'translation_file_patterns' => [
-            [
-                'type' => 'gettext',
-                'base_dir' => __DIR__ . '/../lang',
-                'pattern' => '%s.mo',
-            ],
-        ],
-    ],
-
-];

module/CLI/lang/es.po

@@ -1,340 +0,0 @@
-msgid ""
-msgstr ""
-"Project-Id-Version: Shlink 1.0\n"
-"POT-Creation-Date: 2018-08-04 16:35+0200\n"
-"PO-Revision-Date: 2018-08-04 16:37+0200\n"
-"Last-Translator: Alejandro Celaya <alejandro@alejandrocelaya.com>\n"
-"Language-Team: \n"
-"Language: es_ES\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"X-Generator: Poedit 2.0.6\n"
-"X-Poedit-Basepath: ..\n"
-"Plural-Forms: nplurals=2; plural=(n != 1);\n"
-"X-Poedit-SourceCharset: UTF-8\n"
-"X-Poedit-KeywordsList: translate;translatePlural\n"
-"X-Poedit-SearchPath-0: src\n"
-"X-Poedit-SearchPath-1: config\n"
-
-msgid "Disables an API key."
-msgstr "Desahbilita una clave de API."
-
-msgid "The API key to disable"
-msgstr "La clave de API a deshabilitar"
-
-#, php-format
-msgid "API key \"%s\" properly disabled"
-msgstr "Clave de API \"%s\" deshabilitada correctamente"
-
-#, php-format
-msgid "API key \"%s\" does not exist."
-msgstr "La clave de API \"%s\" no existe."
-
-msgid "Generates a new valid API key."
-msgstr "Genera una nueva clave de API válida."
-
-msgid "The date in which the API key should expire. Use any valid PHP format."
-msgstr ""
-"La fecha en la que la clave de API debe expirar. Utiliza cualquier valor "
-"válido en PHP."
-
-#, php-format
-msgid "Generated API key: \"%s\""
-msgstr "Generada clave de API. \"%s\""
-
-msgid "Lists all the available API keys."
-msgstr "Lista todas las claves de API disponibles."
-
-msgid "Tells if only enabled API keys should be returned."
-msgstr "Define si sólo las claves de API habilitadas deben ser devueltas."
-
-msgid "Key"
-msgstr "Clave"
-
-msgid "Is enabled"
-msgstr "Está habilitada"
-
-msgid "Expiration date"
-msgstr "Fecha de caducidad"
-
-#, php-format
-msgid ""
-"Generates a character set sample just by shuffling the default one, \"%s\". "
-"Then it can be set in the SHORTCODE_CHARS environment variable"
-msgstr ""
-"Genera un grupo de caracteres simplemente mexclando el grupo por defecto \"%s"
-"\". Después puede ser utilizado en la variable de entrono SHORTCODE_CHARS"
-
-#, php-format
-msgid "Character set: \"%s\""
-msgstr "Grupo de caracteres: \"%s\""
-
-msgid ""
-"Generates a random secret string that can be used for JWT token encryption"
-msgstr ""
-"Genera una cadena de caracteres aleatoria que puede ser usada para cifrar "
-"tokens JWT"
-
-#, php-format
-msgid "Secret key: \"%s\""
-msgstr "Clave secreta: \"%s\""
-
-msgid ""
-"Processes and generates the previews for every URL, improving performance "
-"for later web requests."
-msgstr ""
-"Procesa y genera las vistas previas para cada URL, mejorando el rendimiento "
-"para peticiones web posteriores."
-
-msgid "Finished processing all URLs"
-msgstr "Finalizado el procesado de todas las URLs"
-
-#, php-format
-msgid "Processing URL %s..."
-msgstr "Procesando URL %s..."
-
-msgid " <info>Success!</info>"
-msgstr " <info>¡Correcto!</info>"
-
-msgid "Error"
-msgstr "Error"
-
-msgid "Generates a short code for provided URL and returns the short URL"
-msgstr ""
-"Genera un código corto para la URL proporcionada y devuelve la URL acortada"
-
-msgid "The long URL to parse"
-msgstr "La URL larga a procesar"
-
-msgid "Tags to apply to the new short URL"
-msgstr "Etiquetas a aplicar a la nueva URL acortada"
-
-msgid ""
-"The date from which this short URL will be valid. If someone tries to access "
-"it before this date, it will not be found."
-msgstr ""
-"La fecha desde la cual será válida esta URL acortada. Si alguien intenta "
-"acceder a ella antes de esta fecha, no será encontrada."
-
-msgid ""
-"The date until which this short URL will be valid. If someone tries to "
-"access it after this date, it will not be found."
-msgstr ""
-"La fecha hasta la cual será válida está URL acortada. Si alguien intenta "
-"acceder a ella después de esta fecha, no será encontrada."
-
-msgid "If provided, this slug will be used instead of generating a short code"
-msgstr ""
-"Si se proporciona, este slug será usado en vez de generar un código corto"
-
-msgid "This will limit the number of visits for this short URL."
-msgstr "Esto limitará el número de visitas a esta URL acortada."
-
-#, fuzzy
-#| msgid "A long URL was not provided. Which URL do you want to shorten?:"
-msgid "A long URL was not provided. Which URL do you want to be shortened?"
-msgstr "No se ha proporcionado una URL larga. ¿Qué URL deseas acortar?"
-
-msgid "A URL was not provided!"
-msgstr "¡No se ha proporcionado una URL!"
-
-msgid "Processed long URL:"
-msgstr "URL larga procesada:"
-
-msgid "Generated short URL:"
-msgstr "URL corta generada:"
-
-#, php-format
-msgid "Provided URL \"%s\" is invalid. Try with a different one."
-msgstr "La URL proporcionada \"%s\" e inválida. Prueba con una diferente."
-
-#, php-format
-msgid ""
-"Provided slug \"%s\" is already in use by another URL. Try with a different "
-"one."
-msgstr ""
-"El slug proporcionado \"%s\" ya está siendo usado para otra URL. Prueba con "
-"uno diferente."
-
-msgid "Returns the detailed visits information for provided short code"
-msgstr ""
-"Devuelve la información detallada de visitas para el código corto "
-"proporcionado"
-
-msgid "The short code which visits we want to get"
-msgstr "El código corto del cual queremos obtener las visitas"
-
-msgid "Allows to filter visits, returning only those older than start date"
-msgstr ""
-"Permite filtrar las visitas, devolviendo sólo aquellas más antiguas que "
-"startDate"
-
-msgid "Allows to filter visits, returning only those newer than end date"
-msgstr ""
-"Permite filtrar las visitas, devolviendo sólo aquellas más nuevas que endDate"
-
-msgid "A short code was not provided. Which short code do you want to use?"
-msgstr "No se proporcionó un código corto. ¿Qué código corto deseas usar?"
-
-msgid "Referer"
-msgstr "Origen"
-
-msgid "Date"
-msgstr "Fecha"
-
-msgid "Remote Address"
-msgstr "Dirección remota"
-
-msgid "User agent"
-msgstr "Agente de usuario"
-
-msgid "List all short URLs"
-msgstr "Listar todas las URLs cortas"
-
-#, php-format
-msgid "The first page to list (%s items per page)"
-msgstr "La primera página a listar (%s elementos por página)"
-
-msgid ""
-"A query used to filter results by searching for it on the longUrl and "
-"shortCode fields"
-msgstr ""
-"Una consulta usada para filtrar el resultado buscándola en los campos "
-"longUrl y shortCode"
-
-msgid "A comma-separated list of tags to filter results"
-msgstr "Una lista de etiquetas separadas por coma para filtrar el resultado"
-
-msgid ""
-"The field from which we want to order by. Pass ASC or DESC separated by a "
-"comma"
-msgstr ""
-"El campo por el cual queremos ordernar. Pasa ASC o DESC separado por una coma"
-
-msgid "Whether to display the tags or not"
-msgstr "Si se desea mostrar las etiquetas o no"
-
-msgid "Short code"
-msgstr "Código corto"
-
-msgid "Original URL"
-msgstr "URL original"
-
-msgid "Date created"
-msgstr "Fecha de creación"
-
-msgid "Visits count"
-msgstr "Número de visitas"
-
-msgid "Tags"
-msgstr "Etiquetas"
-
-msgid "Short codes properly listed"
-msgstr "Códigos cortos correctamente listados"
-
-msgid "Continue with page"
-msgstr "Continuar con la página"
-
-msgid "Returns the long URL behind a short code"
-msgstr "Devuelve la URL larga detrás de un código corto"
-
-msgid "The short code to parse"
-msgstr "El código corto a convertir"
-
-msgid "A short code was not provided. Which short code do you want to parse?"
-msgstr ""
-"No se proporcionó un código corto. ¿Qué código corto quieres convertir?"
-
-msgid "Long URL:"
-msgstr "URL larga:"
-
-#, php-format
-msgid "Provided short code \"%s\" has an invalid format."
-msgstr "El código corto proporcionado \"%s\" tiene un formato inválido."
-
-#, php-format
-msgid "Provided short code \"%s\" could not be found."
-msgstr "El código corto proporcionado \"%s\" no ha podido ser encontrado."
-
-msgid "Creates one or more tags."
-msgstr "Crea una o más etiquetas."
-
-msgid "The name of the tags to create"
-msgstr "El nombre de las etiquetas a crear"
-
-msgid "You have to provide at least one tag name"
-msgstr "Debes proporcionar al menos un nombre de etiqueta"
-
-msgid "Tags properly created"
-msgstr "Etiquetas correctamente creadas"
-
-msgid "Deletes one or more tags."
-msgstr "Elimina una o más etiquetas."
-
-msgid "The name of the tags to delete"
-msgstr "El nombre de las etiquetas a eliminar"
-
-msgid "Tags properly deleted"
-msgstr "Etiquetas correctamente eliminadas"
-
-msgid "Lists existing tags."
-msgstr "Lista las etiquetas existentes."
-
-#, fuzzy
-msgid "Name"
-msgstr "Nombre"
-
-msgid "No tags yet"
-msgstr "Aún no hay etiquetas"
-
-msgid "Renames one existing tag."
-msgstr "Renombra una etiqueta existente."
-
-msgid "Current name of the tag."
-msgstr "Nombre actual de la etiqueta."
-
-msgid "New name of the tag."
-msgstr "Nuevo nombre de la etiqueta."
-
-msgid "Tag properly renamed."
-msgstr "Etiqueta correctamente renombrada."
-
-#, php-format
-msgid "A tag with name \"%s\" was not found"
-msgstr "Una etiqueta con nombre \"%s\" no ha sido encontrada"
-
-msgid "Processes visits where location is not set yet"
-msgstr "Procesa las visitas donde la localización no ha sido establecida aún"
-
-msgid "Processing IP"
-msgstr "Procesando IP"
-
-msgid "Ignored localhost address"
-msgstr "Ignorada IP de localhost"
-
-#, php-format
-msgid "Address located at \"%s\""
-msgstr "Dirección localizada en \"%s\""
-
-msgid "An error occurred while locating IP"
-msgstr "Se produjo un error al localizar la IP"
-
-#, php-format
-msgid "IP location resolver limit reached. Waiting %s seconds..."
-msgstr "Limite del localizador de IPs alcanzado. Esperando %s segundos..."
-
-msgid "Finished processing all IPs"
-msgstr "Finalizado el procesado de todas las IPs"
-
-#~ msgid "You have reached last page"
-#~ msgstr "Has alcanzado la última página"
-
-#~ msgid "No URL found for short code \"%s\""
-#~ msgstr "No se ha encontrado ninguna URL para el código corto \"%s\""
-
-#~ msgid "Created tags"
-#~ msgstr "Etiquetas creadas"
-
-#~ msgid "Deleted tags"
-#~ msgstr "Etiquetas eliminadas"

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

@@ -3,51 +3,49 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\Command\Api;
 
+use InvalidArgumentException;
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
 use Shlinkio\Shlink\Rest\Service\ApiKeyServiceInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
+
+use function sprintf;
 
 class DisableKeyCommand extends Command
 {
-    const NAME = 'api-key:disable';
+    public const NAME = 'api-key:disable';
 
-    /**
-     * @var ApiKeyServiceInterface
-     */
+    /** @var ApiKeyServiceInterface */
     private $apiKeyService;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
 
-    public function __construct(ApiKeyServiceInterface $apiKeyService, TranslatorInterface $translator)
+    public function __construct(ApiKeyServiceInterface $apiKeyService)
     {
-        $this->apiKeyService = $apiKeyService;
-        $this->translator = $translator;
         parent::__construct();
+        $this->apiKeyService = $apiKeyService;
     }
 
-    public function configure()
+    protected function configure(): void
     {
         $this->setName(self::NAME)
-             ->setDescription($this->translator->translate('Disables an API key.'))
-             ->addArgument('apiKey', InputArgument::REQUIRED, $this->translator->translate('The API key to disable'));
+             ->setDescription('Disables an API key.')
+             ->addArgument('apiKey', InputArgument::REQUIRED, 'The API key to disable');
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
         $apiKey = $input->getArgument('apiKey');
         $io = new SymfonyStyle($input, $output);
 
         try {
             $this->apiKeyService->disable($apiKey);
-            $io->success(sprintf($this->translator->translate('API key "%s" properly disabled'), $apiKey));
-        } catch (\InvalidArgumentException $e) {
-            $io->error(sprintf($this->translator->translate('API key "%s" does not exist.'), $apiKey));
+            $io->success(sprintf('API key "%s" properly disabled', $apiKey));
+            return ExitCodes::EXIT_SUCCESS;
+        } catch (InvalidArgumentException $e) {
+            $io->error(sprintf('API key "%s" does not exist.', $apiKey));
+            return ExitCodes::EXIT_FAILURE;
         }
     }
 }

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

@@ -3,53 +3,49 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\Command\Api;
 
+use Cake\Chronos\Chronos;
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
 use Shlinkio\Shlink\Rest\Service\ApiKeyServiceInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
+
+use function sprintf;
 
 class GenerateKeyCommand extends Command
 {
-    const NAME = 'api-key:generate';
+    public const NAME = 'api-key:generate';
 
-    /**
-     * @var ApiKeyServiceInterface
-     */
+    /** @var ApiKeyServiceInterface */
     private $apiKeyService;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
 
-    public function __construct(ApiKeyServiceInterface $apiKeyService, TranslatorInterface $translator)
+    public function __construct(ApiKeyServiceInterface $apiKeyService)
     {
         $this->apiKeyService = $apiKeyService;
-        $this->translator = $translator;
         parent::__construct();
     }
 
-    public function configure()
+    protected function configure(): void
     {
-        $this->setName(self::NAME)
-             ->setDescription($this->translator->translate('Generates a new valid API key.'))
-             ->addOption(
-                 'expirationDate',
-                 'e',
-                 InputOption::VALUE_OPTIONAL,
-                 $this->translator->translate('The date in which the API key should expire. Use any valid PHP format.')
-             );
+        $this
+            ->setName(self::NAME)
+            ->setDescription('Generates a new valid API key.')
+            ->addOption(
+                'expirationDate',
+                'e',
+                InputOption::VALUE_OPTIONAL,
+                'The date in which the API key should expire. Use any valid PHP format.'
+            );
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
         $expirationDate = $input->getOption('expirationDate');
-        $apiKey = $this->apiKeyService->create(isset($expirationDate) ? new \DateTime($expirationDate) : null);
+        $apiKey = $this->apiKeyService->create(isset($expirationDate) ? Chronos::parse($expirationDate) : null);
 
-        (new SymfonyStyle($input, $output))->success(
-            sprintf($this->translator->translate('Generated API key: "%s"'), $apiKey)
-        );
+        (new SymfonyStyle($input, $output))->success(sprintf('Generated API key: "%s"', $apiKey));
+        return ExitCodes::EXIT_SUCCESS;
     }
 }

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

@@ -3,14 +3,18 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\Command\Api;
 
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\Common\Console\ShlinkTable;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 use Shlinkio\Shlink\Rest\Service\ApiKeyServiceInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
+
+use function array_filter;
+use function array_map;
+use function sprintf;
 
 class ListKeysCommand extends Command
 {
@@ -20,62 +24,51 @@ class ListKeysCommand extends Command
 
     public const NAME = 'api-key:list';
 
-    /**
-     * @var ApiKeyServiceInterface
-     */
+    /** @var ApiKeyServiceInterface */
     private $apiKeyService;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
 
-    public function __construct(ApiKeyServiceInterface $apiKeyService, TranslatorInterface $translator)
+    public function __construct(ApiKeyServiceInterface $apiKeyService)
     {
-        $this->apiKeyService = $apiKeyService;
-        $this->translator = $translator;
         parent::__construct();
+        $this->apiKeyService = $apiKeyService;
     }
 
-    public function configure()
+    protected function configure(): void
     {
-        $this->setName(self::NAME)
-             ->setDescription($this->translator->translate('Lists all the available API keys.'))
-             ->addOption(
-                 'enabledOnly',
-                 null,
-                 InputOption::VALUE_NONE,
-                 $this->translator->translate('Tells if only enabled API keys should be returned.')
-             );
+        $this
+            ->setName(self::NAME)
+            ->setDescription('Lists all the available API keys.')
+            ->addOption(
+                'enabledOnly',
+                'e',
+                InputOption::VALUE_NONE,
+                'Tells if only enabled API keys should be returned.'
+            );
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
-        $io = new SymfonyStyle($input, $output);
         $enabledOnly = $input->getOption('enabledOnly');
-        $list = $this->apiKeyService->listKeys($enabledOnly);
-        $rows = [];
 
-        /** @var ApiKey $row */
-        foreach ($list as $row) {
-            $key = $row->getKey();
-            $expiration = $row->getExpirationDate();
-            $messagePattern = $this->determineMessagePattern($row);
+        $rows = array_map(function (ApiKey $apiKey) use ($enabledOnly) {
+            $expiration = $apiKey->getExpirationDate();
+            $messagePattern = $this->determineMessagePattern($apiKey);
 
             // Set columns for this row
-            $rowData = [\sprintf($messagePattern, $key)];
+            $rowData = [sprintf($messagePattern, $apiKey)];
             if (! $enabledOnly) {
-                $rowData[] = \sprintf($messagePattern, $this->getEnabledSymbol($row));
+                $rowData[] = sprintf($messagePattern, $this->getEnabledSymbol($apiKey));
             }
-            $rowData[] = $expiration !== null ? $expiration->format(\DateTime::ATOM) : '-';
+            $rowData[] = $expiration !== null ? $expiration->toAtomString() : '-';
+            return $rowData;
+        }, $this->apiKeyService->listKeys($enabledOnly));
 
-            $rows[] = $rowData;
-        }
-
-        $io->table(\array_filter([
-            $this->translator->translate('Key'),
-            ! $enabledOnly ? $this->translator->translate('Is enabled') : null,
-            $this->translator->translate('Expiration date'),
+        ShlinkTable::fromOutput($output)->render(array_filter([
+            'Key',
+            ! $enabledOnly ? 'Is enabled' : null,
+            'Expiration date',
         ]), $rows);
+        return ExitCodes::EXIT_SUCCESS;
     }
 
     private function determineMessagePattern(ApiKey $apiKey): string

module/CLI/src/Command/Config/GenerateCharsetCommand.php

@@ -3,42 +3,37 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\Command\Config;
 
-use Shlinkio\Shlink\Core\Service\UrlShortener;
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\Core\Options\UrlShortenerOptions;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
 
+use function sprintf;
+use function str_shuffle;
+
+/** @deprecated */
 class GenerateCharsetCommand extends Command
 {
-    const NAME = 'config:generate-charset';
+    public const NAME = 'config:generate-charset';
 
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
-
-    public function __construct(TranslatorInterface $translator)
+    protected function configure(): void
     {
-        $this->translator = $translator;
-        parent::__construct();
+        $this
+            ->setName(self::NAME)
+            ->setDescription(sprintf(
+                '[DEPRECATED] Generates a character set sample just by shuffling the default one, "%s". '
+                . 'Then it can be set in the SHORTCODE_CHARS environment variable',
+                UrlShortenerOptions::DEFAULT_CHARS
+            ))
+            ->setHelp('<fg=red;options=bold>This command is deprecated. Better leave shlink generate the charset.</>');
     }
 
-    public function configure()
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
-        $this->setName(self::NAME)
-             ->setDescription(sprintf($this->translator->translate(
-                 'Generates a character set sample just by shuffling the default one, "%s". '
-                 . 'Then it can be set in the SHORTCODE_CHARS environment variable'
-             ), UrlShortener::DEFAULT_CHARS));
-    }
-
-    public function execute(InputInterface $input, OutputInterface $output)
-    {
-        $charSet = str_shuffle(UrlShortener::DEFAULT_CHARS);
-        (new SymfonyStyle($input, $output))->success(
-            \sprintf($this->translator->translate('Character set: "%s"'), $charSet)
-        );
+        $charSet = str_shuffle(UrlShortenerOptions::DEFAULT_CHARS);
+        (new SymfonyStyle($input, $output))->success(sprintf('Character set: "%s"', $charSet));
+        return ExitCodes::EXIT_SUCCESS;
     }
 }

module/CLI/src/Command/Config/GenerateSecretCommand.php

@@ -3,43 +3,36 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\Command\Config;
 
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
 use Shlinkio\Shlink\Common\Util\StringUtilsTrait;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
 
+use function sprintf;
+
+/** @deprecated */
 class GenerateSecretCommand extends Command
 {
     use StringUtilsTrait;
 
-    const NAME = 'config:generate-secret';
+    public const NAME = 'config:generate-secret';
 
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
-
-    public function __construct(TranslatorInterface $translator)
+    protected function configure(): void
     {
-        $this->translator = $translator;
-        parent::__construct();
+        $this
+            ->setName(self::NAME)
+            ->setDescription('[DEPRECATED] Generates a random secret string that can be used for JWT token encryption')
+            ->setHelp(
+                '<fg=red;options=bold>This command is deprecated. Better leave shlink generate the secret key.</>'
+            );
     }
 
-    public function configure()
-    {
-        $this->setName(self::NAME)
-             ->setDescription($this->translator->translate(
-                 'Generates a random secret string that can be used for JWT token encryption'
-             ));
-    }
-
-    public function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
         $secret = $this->generateRandomString(32);
-        (new SymfonyStyle($input, $output))->success(
-            sprintf($this->translator->translate('Secret key: "%s"'), $secret)
-        );
+        (new SymfonyStyle($input, $output))->success(sprintf('Secret key: "%s"', $secret));
+        return ExitCodes::EXIT_SUCCESS;
     }
 }

module/CLI/src/Command/Install/InstallCommand.php

@@ -1,251 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\CLI\Command\Install;
-
-use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\NotFoundExceptionInterface;
-use Shlinkio\Shlink\CLI\Install\ConfigCustomizerManagerInterface;
-use Shlinkio\Shlink\CLI\Install\Plugin;
-use Shlinkio\Shlink\CLI\Model\CustomizableAppConfig;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Exception\InvalidArgumentException;
-use Symfony\Component\Console\Exception\LogicException;
-use Symfony\Component\Console\Exception\RuntimeException;
-use Symfony\Component\Console\Helper\ProcessHelper;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Style\SymfonyStyle;
-use Symfony\Component\Filesystem\Exception\IOException;
-use Symfony\Component\Filesystem\Filesystem;
-use Symfony\Component\Process\PhpExecutableFinder;
-use Zend\Config\Writer\WriterInterface;
-
-class InstallCommand extends Command
-{
-    const GENERATED_CONFIG_PATH = 'config/params/generated_config.php';
-
-    /**
-     * @var SymfonyStyle
-     */
-    private $io;
-    /**
-     * @var ProcessHelper
-     */
-    private $processHelper;
-    /**
-     * @var WriterInterface
-     */
-    private $configWriter;
-    /**
-     * @var Filesystem
-     */
-    private $filesystem;
-    /**
-     * @var ConfigCustomizerManagerInterface
-     */
-    private $configCustomizers;
-    /**
-     * @var bool
-     */
-    private $isUpdate;
-    /**
-     * @var PhpExecutableFinder
-     */
-    private $phpFinder;
-    /**
-     * @var string|bool
-     */
-    private $phpBinary;
-
-    /**
-     * InstallCommand constructor.
-     * @param WriterInterface $configWriter
-     * @param Filesystem $filesystem
-     * @param ConfigCustomizerManagerInterface $configCustomizers
-     * @param bool $isUpdate
-     * @param PhpExecutableFinder|null $phpFinder
-     * @throws LogicException
-     */
-    public function __construct(
-        WriterInterface $configWriter,
-        Filesystem $filesystem,
-        ConfigCustomizerManagerInterface $configCustomizers,
-        bool $isUpdate = false,
-        PhpExecutableFinder $phpFinder = null
-    ) {
-        parent::__construct();
-        $this->configWriter = $configWriter;
-        $this->isUpdate = $isUpdate;
-        $this->filesystem = $filesystem;
-        $this->configCustomizers = $configCustomizers;
-        $this->phpFinder = $phpFinder ?: new PhpExecutableFinder();
-    }
-
-    protected function configure(): void
-    {
-        $this
-            ->setName('shlink:install')
-            ->setDescription('Installs or updates Shlink');
-    }
-
-    /**
-     * @param InputInterface $input
-     * @param OutputInterface $output
-     * @return void
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
-     */
-    protected function execute(InputInterface $input, OutputInterface $output): void
-    {
-        $this->io = new SymfonyStyle($input, $output);
-
-        $this->io->writeln([
-            '<info>Welcome to Shlink!!</info>',
-            'This will guide you through the installation process.',
-        ]);
-
-        // Check if a cached config file exists and drop it if so
-        if ($this->filesystem->exists('data/cache/app_config.php')) {
-            $this->io->write('Deleting old cached config...');
-            try {
-                $this->filesystem->remove('data/cache/app_config.php');
-                $this->io->writeln(' <info>Success</info>');
-            } catch (IOException $e) {
-                $this->io->error(
-                    'Failed! You will have to manually delete the data/cache/app_config.php file to'
-                    . ' get new config applied.'
-                );
-                if ($this->io->isVerbose()) {
-                    $this->getApplication()->renderException($e, $output);
-                }
-                return;
-            }
-        }
-
-        // If running update command, ask the user to import previous config
-        $config = $this->isUpdate ? $this->importConfig() : new CustomizableAppConfig();
-
-        // Ask for custom config params
-        foreach ([
-            Plugin\DatabaseConfigCustomizer::class,
-            Plugin\UrlShortenerConfigCustomizer::class,
-            Plugin\LanguageConfigCustomizer::class,
-            Plugin\ApplicationConfigCustomizer::class,
-        ] as $pluginName) {
-            /** @var Plugin\ConfigCustomizerInterface $configCustomizer */
-            $configCustomizer = $this->configCustomizers->get($pluginName);
-            $configCustomizer->process($this->io, $config);
-        }
-
-        // Generate config params files
-        $this->configWriter->toFile(self::GENERATED_CONFIG_PATH, $config->getArrayCopy(), false);
-        $this->io->writeln(['<info>Custom configuration properly generated!</info>', '']);
-
-        // If current command is not update, generate database
-        if (!  $this->isUpdate) {
-            $this->io->write('Initializing database...');
-            if (! $this->runPhpCommand(
-                'vendor/doctrine/orm/bin/doctrine.php orm:schema-tool:create',
-                'Error generating database.',
-                $output
-            )) {
-                return;
-            }
-        }
-
-        // Run database migrations
-        $this->io->write('Updating database...');
-        if (! $this->runPhpCommand(
-            'vendor/doctrine/migrations/bin/doctrine-migrations.php migrations:migrate',
-            'Error updating database.',
-            $output
-        )) {
-            return;
-        }
-
-        // Generate proxies
-        $this->io->write('Generating proxies...');
-        if (! $this->runPhpCommand(
-            'vendor/doctrine/orm/bin/doctrine.php orm:generate-proxies',
-            'Error generating proxies.',
-            $output
-        )) {
-            return;
-        }
-
-        $this->io->success('Installation complete!');
-    }
-
-    /**
-     * @return CustomizableAppConfig
-     * @throws RuntimeException
-     */
-    private function importConfig(): CustomizableAppConfig
-    {
-        $config = new CustomizableAppConfig();
-
-        // Ask the user if he/she wants to import an older configuration
-        $importConfig = $this->io->confirm('Do you want to import configuration from previous installation?');
-        if (! $importConfig) {
-            return $config;
-        }
-
-        // Ask the user for the older shlink path
-        $keepAsking = true;
-        do {
-            $config->setImportedInstallationPath($this->io->ask(
-                'Previous shlink installation path from which to import config'
-            ));
-            $configFile = $config->getImportedInstallationPath() . '/' . self::GENERATED_CONFIG_PATH;
-            $configExists = $this->filesystem->exists($configFile);
-
-            if (! $configExists) {
-                $keepAsking = $this->io->confirm(
-                    'Provided path does not seem to be a valid shlink root path. Do you want to try another path?'
-                );
-            }
-        } while (! $configExists && $keepAsking);
-
-        // If after some retries the user has chosen not to test another path, return
-        if (! $configExists) {
-            return $config;
-        }
-
-        // Read the config file
-        $config->exchangeArray(include $configFile);
-        return $config;
-    }
-
-    /**
-     * @param string $command
-     * @param string $errorMessage
-     * @param OutputInterface $output
-     * @return bool
-     * @throws LogicException
-     * @throws InvalidArgumentException
-     */
-    private function runPhpCommand($command, $errorMessage, OutputInterface $output): bool
-    {
-        if ($this->processHelper === null) {
-            $this->processHelper = $this->getHelper('process');
-        }
-
-        if ($this->phpBinary === null) {
-            $this->phpBinary = $this->phpFinder->find(false) ?: 'php';
-        }
-
-        $this->io->writeln('Running "' . sprintf('%s %s', $this->phpBinary, $command) . '"');
-        $process = $this->processHelper->run($output, sprintf('%s %s', $this->phpBinary, $command));
-        if ($process->isSuccessful()) {
-            $this->io->writeln(' <info>Success!</info>');
-            return true;
-        }
-
-        if (! $this->io->isVerbose()) {
-            $this->io->error($errorMessage . '  Run this command with -vvv to see specific error info.');
-        }
-
-        return false;
-    }
-}

module/CLI/src/Command/ShortUrl/DeleteShortUrlCommand.php

@@ -0,0 +1,89 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
+
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\Core\Exception;
+use Shlinkio\Shlink\Core\Service\ShortUrl\DeleteShortUrlServiceInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+use function sprintf;
+
+class DeleteShortUrlCommand extends Command
+{
+    public const NAME = 'short-url:delete';
+    private const ALIASES = ['short-code:delete'];
+
+    /** @var DeleteShortUrlServiceInterface */
+    private $deleteShortUrlService;
+
+    public function __construct(DeleteShortUrlServiceInterface $deleteShortUrlService)
+    {
+        parent::__construct();
+        $this->deleteShortUrlService = $deleteShortUrlService;
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::NAME)
+            ->setAliases(self::ALIASES)
+            ->setDescription('Deletes a short URL')
+            ->addArgument('shortCode', InputArgument::REQUIRED, 'The short code for the short URL to be deleted')
+            ->addOption(
+                'ignore-threshold',
+                'i',
+                InputOption::VALUE_NONE,
+                'Ignores the safety visits threshold check, which could make short URLs with many visits to be '
+                . 'accidentally deleted'
+            );
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $shortCode = $input->getArgument('shortCode');
+        $ignoreThreshold = $input->getOption('ignore-threshold');
+
+        try {
+            $this->runDelete($io, $shortCode, $ignoreThreshold);
+            return ExitCodes::EXIT_SUCCESS;
+        } catch (Exception\InvalidShortCodeException $e) {
+            $io->error(sprintf('Provided short code "%s" could not be found.', $shortCode));
+            return ExitCodes::EXIT_FAILURE;
+        } catch (Exception\DeleteShortUrlException $e) {
+            return $this->retry($io, $shortCode, $e);
+        }
+    }
+
+    private function retry(SymfonyStyle $io, string $shortCode, Exception\DeleteShortUrlException $e): int
+    {
+        $warningMsg = sprintf(
+            'It was not possible to delete the short URL with short code "%s" because it has more than %s visits.',
+            $shortCode,
+            $e->getVisitsThreshold()
+        );
+        $io->writeln('<bg=yellow>' . $warningMsg . '</>');
+        $forceDelete = $io->confirm('Do you want to delete it anyway?', false);
+
+        if ($forceDelete) {
+            $this->runDelete($io, $shortCode, true);
+        } else {
+            $io->warning('Short URL was not deleted.');
+        }
+
+        return $forceDelete ? ExitCodes::EXIT_SUCCESS : ExitCodes::EXIT_WARNING;
+    }
+
+    private function runDelete(SymfonyStyle $io, string $shortCode, bool $ignoreThreshold): void
+    {
+        $this->deleteShortUrlService->deleteByShortCode($shortCode, $ignoreThreshold);
+        $io->success(sprintf('Short URL with short code "%s" successfully deleted.', $shortCode));
+    }
+}

module/CLI/src/Command/ShortUrl/GeneratePreviewCommand.php

@@ -0,0 +1,73 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
+
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
+use Shlinkio\Shlink\Common\Service\PreviewGeneratorInterface;
+use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+use function sprintf;
+
+class GeneratePreviewCommand extends Command
+{
+    public const NAME = 'short-url:process-previews';
+    private const ALIASES = ['shortcode:process-previews', 'short-code:process-previews'];
+
+    /** @var PreviewGeneratorInterface */
+    private $previewGenerator;
+    /** @var ShortUrlServiceInterface */
+    private $shortUrlService;
+
+    public function __construct(ShortUrlServiceInterface $shortUrlService, PreviewGeneratorInterface $previewGenerator)
+    {
+        parent::__construct();
+        $this->shortUrlService = $shortUrlService;
+        $this->previewGenerator = $previewGenerator;
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::NAME)
+            ->setAliases(self::ALIASES)
+            ->setDescription(
+                'Processes and generates the previews for every URL, improving performance for later web requests.'
+            );
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    {
+        $page = 1;
+        do {
+            $shortUrls = $this->shortUrlService->listShortUrls($page);
+            $page += 1;
+
+            foreach ($shortUrls as $shortUrl) {
+                $this->processUrl($shortUrl->getLongUrl(), $output);
+            }
+        } while ($page <= $shortUrls->count());
+
+        (new SymfonyStyle($input, $output))->success('Finished processing all URLs');
+        return ExitCodes::EXIT_SUCCESS;
+    }
+
+    private function processUrl($url, OutputInterface $output): void
+    {
+        try {
+            $output->write(sprintf('Processing URL %s...', $url));
+            $this->previewGenerator->generatePreview($url);
+            $output->writeln(' <info>Success!</info>');
+        } catch (PreviewGenerationException $e) {
+            $output->writeln(' <error>Error</error>');
+            if ($output->isVerbose()) {
+                $this->getApplication()->renderException($e, $output);
+            }
+        }
+    }
+}

module/CLI/src/Command/ShortUrl/GenerateShortUrlCommand.php

@@ -0,0 +1,156 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
+
+use Cake\Chronos\Chronos;
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
+use Shlinkio\Shlink\Core\Exception\NonUniqueSlugException;
+use Shlinkio\Shlink\Core\Model\ShortUrlMeta;
+use Shlinkio\Shlink\Core\Service\UrlShortenerInterface;
+use Shlinkio\Shlink\Core\Util\ShortUrlBuilderTrait;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Zend\Diactoros\Uri;
+
+use function array_map;
+use function Functional\curry;
+use function Functional\flatten;
+use function Functional\unique;
+use function sprintf;
+
+class GenerateShortUrlCommand extends Command
+{
+    use ShortUrlBuilderTrait;
+
+    public const NAME = 'short-url:generate';
+    private const ALIASES = ['shortcode:generate', 'short-code:generate'];
+
+    /** @var UrlShortenerInterface */
+    private $urlShortener;
+    /** @var array */
+    private $domainConfig;
+
+    public function __construct(UrlShortenerInterface $urlShortener, array $domainConfig)
+    {
+        parent::__construct();
+        $this->urlShortener = $urlShortener;
+        $this->domainConfig = $domainConfig;
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::NAME)
+            ->setAliases(self::ALIASES)
+            ->setDescription('Generates a short URL for provided long URL and returns it')
+            ->addArgument('longUrl', InputArgument::REQUIRED, 'The long URL to parse')
+            ->addOption(
+                'tags',
+                't',
+                InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED,
+                'Tags to apply to the new short URL'
+            )
+            ->addOption(
+                'validSince',
+                's',
+                InputOption::VALUE_REQUIRED,
+                'The date from which this short URL will be valid. '
+                . 'If someone tries to access it before this date, it will not be found.'
+            )
+            ->addOption(
+                'validUntil',
+                'u',
+                InputOption::VALUE_REQUIRED,
+                'The date until which this short URL will be valid. '
+                . 'If someone tries to access it after this date, it will not be found.'
+            )
+            ->addOption(
+                'customSlug',
+                'c',
+                InputOption::VALUE_REQUIRED,
+                'If provided, this slug will be used instead of generating a short code'
+            )
+            ->addOption(
+                'maxVisits',
+                'm',
+                InputOption::VALUE_REQUIRED,
+                'This will limit the number of visits for this short URL.'
+            )
+            ->addOption(
+                'findIfExists',
+                'f',
+                InputOption::VALUE_NONE,
+                'This will force existing matching URL to be returned if found, instead of creating a new one.'
+            );
+    }
+
+    protected function interact(InputInterface $input, OutputInterface $output): void
+    {
+        $io = new SymfonyStyle($input, $output);
+        $longUrl = $input->getArgument('longUrl');
+        if (! empty($longUrl)) {
+            return;
+        }
+
+        $longUrl = $io->ask('A long URL was not provided. Which URL do you want to be shortened?');
+        if (! empty($longUrl)) {
+            $input->setArgument('longUrl', $longUrl);
+        }
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $longUrl = $input->getArgument('longUrl');
+        if (empty($longUrl)) {
+            $io->error('A URL was not provided!');
+            return ExitCodes::EXIT_FAILURE;
+        }
+
+        $explodeWithComma = curry('explode')(',');
+        $tags = unique(flatten(array_map($explodeWithComma, $input->getOption('tags'))));
+        $customSlug = $input->getOption('customSlug');
+        $maxVisits = $input->getOption('maxVisits');
+
+        try {
+            $shortCode = $this->urlShortener->urlToShortCode(
+                new Uri($longUrl),
+                $tags,
+                ShortUrlMeta::createFromParams(
+                    $this->getOptionalDate($input, 'validSince'),
+                    $this->getOptionalDate($input, 'validUntil'),
+                    $customSlug,
+                    $maxVisits !== null ? (int) $maxVisits : null,
+                    $input->getOption('findIfExists')
+                )
+            )->getShortCode();
+            $shortUrl = $this->buildShortUrl($this->domainConfig, $shortCode);
+
+            $io->writeln([
+                sprintf('Processed long URL: <info>%s</info>', $longUrl),
+                sprintf('Generated short URL: <info>%s</info>', $shortUrl),
+            ]);
+            return ExitCodes::EXIT_SUCCESS;
+        } catch (InvalidUrlException $e) {
+            $io->error(sprintf('Provided URL "%s" is invalid. Try with a different one.', $longUrl));
+            return ExitCodes::EXIT_FAILURE;
+        } catch (NonUniqueSlugException $e) {
+            $io->error(
+                sprintf('Provided slug "%s" is already in use by another URL. Try with a different one.', $customSlug)
+            );
+            return ExitCodes::EXIT_FAILURE;
+        }
+    }
+
+    private function getOptionalDate(InputInterface $input, string $fieldName): ?Chronos
+    {
+        $since = $input->getOption($fieldName);
+        return $since !== null ? Chronos::parse($since) : null;
+    }
+}

module/CLI/src/Command/ShortUrl/GetVisitsCommand.php

@@ -0,0 +1,96 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
+
+use Cake\Chronos\Chronos;
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\Common\Console\ShlinkTable;
+use Shlinkio\Shlink\Common\Util\DateRange;
+use Shlinkio\Shlink\Core\Entity\Visit;
+use Shlinkio\Shlink\Core\Model\VisitsParams;
+use Shlinkio\Shlink\Core\Service\VisitsTrackerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Zend\Stdlib\ArrayUtils;
+
+use function array_map;
+use function Functional\select_keys;
+
+class GetVisitsCommand extends Command
+{
+    public const NAME = 'short-url:visits';
+    private const ALIASES = ['shortcode:visits', 'short-code:visits'];
+
+    /** @var VisitsTrackerInterface */
+    private $visitsTracker;
+
+    public function __construct(VisitsTrackerInterface $visitsTracker)
+    {
+        $this->visitsTracker = $visitsTracker;
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::NAME)
+            ->setAliases(self::ALIASES)
+            ->setDescription('Returns the detailed visits information for provided short code')
+            ->addArgument('shortCode', InputArgument::REQUIRED, 'The short code which visits we want to get')
+            ->addOption(
+                'startDate',
+                's',
+                InputOption::VALUE_OPTIONAL,
+                'Allows to filter visits, returning only those older than start date'
+            )
+            ->addOption(
+                'endDate',
+                'e',
+                InputOption::VALUE_OPTIONAL,
+                'Allows to filter visits, returning only those newer than end date'
+            );
+    }
+
+    protected function interact(InputInterface $input, OutputInterface $output): void
+    {
+        $shortCode = $input->getArgument('shortCode');
+        if (! empty($shortCode)) {
+            return;
+        }
+
+        $io = new SymfonyStyle($input, $output);
+        $shortCode = $io->ask('A short code was not provided. Which short code do you want to use?');
+        if (! empty($shortCode)) {
+            $input->setArgument('shortCode', $shortCode);
+        }
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    {
+        $shortCode = $input->getArgument('shortCode');
+        $startDate = $this->getDateOption($input, 'startDate');
+        $endDate = $this->getDateOption($input, 'endDate');
+
+        $paginator = $this->visitsTracker->info($shortCode, new VisitsParams(new DateRange($startDate, $endDate)));
+        $visits = ArrayUtils::iteratorToArray($paginator->getCurrentItems());
+
+        $rows = array_map(function (Visit $visit) {
+            $rowData = $visit->jsonSerialize();
+            $rowData['country'] = $visit->getVisitLocation()->getCountryName();
+            return select_keys($rowData, ['referer', 'date', 'userAgent', 'country']);
+        }, $visits);
+        ShlinkTable::fromOutput($output)->render(['Referer', 'Date', 'User agent', 'Country'], $rows);
+        return ExitCodes::EXIT_SUCCESS;
+    }
+
+    private function getDateOption(InputInterface $input, $key)
+    {
+        $value = $input->getOption($key);
+        return ! empty($value) ? Chronos::parse($value) : $value;
+    }
+}

module/CLI/src/Command/ShortUrl/ListShortUrlsCommand.php

@@ -0,0 +1,149 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
+
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\Common\Console\ShlinkTable;
+use Shlinkio\Shlink\Common\Paginator\Adapter\PaginableRepositoryAdapter;
+use Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait;
+use Shlinkio\Shlink\Common\Rest\DataTransformerInterface;
+use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
+use Shlinkio\Shlink\Core\Transformer\ShortUrlDataTransformer;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Zend\Paginator\Paginator;
+
+use function array_values;
+use function count;
+use function explode;
+use function implode;
+use function sprintf;
+
+class ListShortUrlsCommand extends Command
+{
+    use PaginatorUtilsTrait;
+
+    public const NAME = 'short-url:list';
+    private const ALIASES = ['shortcode:list', 'short-code:list'];
+
+    /** @var ShortUrlServiceInterface */
+    private $shortUrlService;
+    /** @var array */
+    private $domainConfig;
+
+    public function __construct(ShortUrlServiceInterface $shortUrlService, array $domainConfig)
+    {
+        parent::__construct();
+        $this->shortUrlService = $shortUrlService;
+        $this->domainConfig = $domainConfig;
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::NAME)
+            ->setAliases(self::ALIASES)
+            ->setDescription('List all short URLs')
+            ->addOption(
+                'page',
+                'p',
+                InputOption::VALUE_OPTIONAL,
+                sprintf('The first page to list (%s items per page)', PaginableRepositoryAdapter::ITEMS_PER_PAGE),
+                '1'
+            )
+            ->addOption(
+                'searchTerm',
+                's',
+                InputOption::VALUE_OPTIONAL,
+                'A query used to filter results by searching for it on the longUrl and shortCode fields'
+            )
+            ->addOption(
+                'tags',
+                't',
+                InputOption::VALUE_OPTIONAL,
+                'A comma-separated list of tags to filter results'
+            )
+            ->addOption(
+                'orderBy',
+                'o',
+                InputOption::VALUE_OPTIONAL,
+                'The field from which we want to order by. Pass ASC or DESC separated by a comma'
+            )
+            ->addOption('showTags', null, InputOption::VALUE_NONE, 'Whether to display the tags or not');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $page = (int) $input->getOption('page');
+        $searchTerm = $input->getOption('searchTerm');
+        $tags = $input->getOption('tags');
+        $tags = ! empty($tags) ? explode(',', $tags) : [];
+        $showTags = (bool) $input->getOption('showTags');
+        $transformer = new ShortUrlDataTransformer($this->domainConfig);
+
+        do {
+            $result = $this->renderPage($input, $output, $page, $searchTerm, $tags, $showTags, $transformer);
+            $page++;
+
+            $continue = $this->isLastPage($result)
+                ? false
+                : $io->confirm(sprintf('Continue with page <options=bold>%s</>?', $page), false);
+        } while ($continue);
+
+        $io->newLine();
+        $io->success('Short URLs properly listed');
+        return ExitCodes::EXIT_SUCCESS;
+    }
+
+    private function renderPage(
+        InputInterface $input,
+        OutputInterface $output,
+        int $page,
+        ?string $searchTerm,
+        array $tags,
+        bool $showTags,
+        DataTransformerInterface $transformer
+    ): Paginator {
+        $result = $this->shortUrlService->listShortUrls($page, $searchTerm, $tags, $this->processOrderBy($input));
+
+        $headers = ['Short code', 'Short URL', 'Long URL', 'Date created', 'Visits count'];
+        if ($showTags) {
+            $headers[] = 'Tags';
+        }
+
+        $rows = [];
+        foreach ($result as $row) {
+            $shortUrl = $transformer->transform($row);
+            if ($showTags) {
+                $shortUrl['tags'] = implode(', ', $shortUrl['tags']);
+            } else {
+                unset($shortUrl['tags']);
+            }
+
+            unset($shortUrl['originalUrl']);
+            $rows[] = array_values($shortUrl);
+        }
+
+        ShlinkTable::fromOutput($output)->render($headers, $rows, $this->formatCurrentPageMessage(
+            $result,
+            'Page %s of %s'
+        ));
+        return $result;
+    }
+
+    private function processOrderBy(InputInterface $input)
+    {
+        $orderBy = $input->getOption('orderBy');
+        if (empty($orderBy)) {
+            return null;
+        }
+
+        $orderBy = explode(',', $orderBy);
+        return count($orderBy) === 1 ? $orderBy[0] : [$orderBy[0] => $orderBy[1]];
+    }
+}

module/CLI/src/Command/ShortUrl/ResolveUrlCommand.php

@@ -0,0 +1,72 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
+
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\Core\Exception\EntityDoesNotExistException;
+use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
+use Shlinkio\Shlink\Core\Service\UrlShortenerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+use function sprintf;
+
+class ResolveUrlCommand extends Command
+{
+    public const NAME = 'short-url:parse';
+    private const ALIASES = ['shortcode:parse', 'short-code:parse'];
+
+    /** @var UrlShortenerInterface */
+    private $urlShortener;
+
+    public function __construct(UrlShortenerInterface $urlShortener)
+    {
+        parent::__construct();
+        $this->urlShortener = $urlShortener;
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::NAME)
+            ->setAliases(self::ALIASES)
+            ->setDescription('Returns the long URL behind a short code')
+            ->addArgument('shortCode', InputArgument::REQUIRED, 'The short code to parse');
+    }
+
+    protected function interact(InputInterface $input, OutputInterface $output): void
+    {
+        $shortCode = $input->getArgument('shortCode');
+        if (! empty($shortCode)) {
+            return;
+        }
+
+        $io = new SymfonyStyle($input, $output);
+        $shortCode = $io->ask('A short code was not provided. Which short code do you want to parse?');
+        if (! empty($shortCode)) {
+            $input->setArgument('shortCode', $shortCode);
+        }
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $shortCode = $input->getArgument('shortCode');
+
+        try {
+            $url = $this->urlShortener->shortCodeToUrl($shortCode);
+            $output->writeln(sprintf('Long URL: <info>%s</info>', $url->getLongUrl()));
+            return ExitCodes::EXIT_SUCCESS;
+        } catch (InvalidShortCodeException $e) {
+            $io->error(sprintf('Provided short code "%s" has an invalid format.', $shortCode));
+            return ExitCodes::EXIT_FAILURE;
+        } catch (EntityDoesNotExistException $e) {
+            $io->error(sprintf('Provided short code "%s" could not be found.', $shortCode));
+            return ExitCodes::EXIT_FAILURE;
+        }
+    }
+}

module/CLI/src/Command/Shortcode/GeneratePreviewCommand.php

@@ -1,81 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
-
-use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
-use Shlinkio\Shlink\Common\Service\PreviewGeneratorInterface;
-use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
-
-class GeneratePreviewCommand extends Command
-{
-    const NAME = 'shortcode:process-previews';
-
-    /**
-     * @var PreviewGeneratorInterface
-     */
-    private $previewGenerator;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
-    /**
-     * @var ShortUrlServiceInterface
-     */
-    private $shortUrlService;
-
-    public function __construct(
-        ShortUrlServiceInterface $shortUrlService,
-        PreviewGeneratorInterface $previewGenerator,
-        TranslatorInterface $translator
-    ) {
-        $this->shortUrlService = $shortUrlService;
-        $this->previewGenerator = $previewGenerator;
-        $this->translator = $translator;
-        parent::__construct(null);
-    }
-
-    public function configure()
-    {
-        $this->setName(self::NAME)
-             ->setDescription(
-                 $this->translator->translate(
-                     'Processes and generates the previews for every URL, improving performance for later web requests.'
-                 )
-             );
-    }
-
-    public function execute(InputInterface $input, OutputInterface $output)
-    {
-        $page = 1;
-        do {
-            $shortUrls = $this->shortUrlService->listShortUrls($page);
-            $page += 1;
-
-            foreach ($shortUrls as $shortUrl) {
-                $this->processUrl($shortUrl->getOriginalUrl(), $output);
-            }
-        } while ($page <= $shortUrls->count());
-
-        (new SymfonyStyle($input, $output))->success($this->translator->translate('Finished processing all URLs'));
-    }
-
-    protected function processUrl($url, OutputInterface $output)
-    {
-        try {
-            $output->write(\sprintf($this->translator->translate('Processing URL %s...'), $url));
-            $this->previewGenerator->generatePreview($url);
-            $output->writeln($this->translator->translate(' <info>Success!</info>'));
-        } catch (PreviewGenerationException $e) {
-            $output->writeln(' <error>' . $this->translator->translate('Error') . '</error>');
-            if ($output->isVerbose()) {
-                $this->getApplication()->renderException($e, $output);
-            }
-        }
-    }
-}

module/CLI/src/Command/Shortcode/GenerateShortcodeCommand.php

@@ -1,147 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
-
-use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
-use Shlinkio\Shlink\Core\Exception\NonUniqueSlugException;
-use Shlinkio\Shlink\Core\Service\UrlShortenerInterface;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputArgument;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\Diactoros\Uri;
-use Zend\I18n\Translator\TranslatorInterface;
-
-class GenerateShortcodeCommand extends Command
-{
-    const NAME = 'shortcode:generate';
-
-    /**
-     * @var UrlShortenerInterface
-     */
-    private $urlShortener;
-    /**
-     * @var array
-     */
-    private $domainConfig;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
-
-    public function __construct(
-        UrlShortenerInterface $urlShortener,
-        TranslatorInterface $translator,
-        array $domainConfig
-    ) {
-        $this->urlShortener = $urlShortener;
-        $this->translator = $translator;
-        $this->domainConfig = $domainConfig;
-        parent::__construct(null);
-    }
-
-    public function configure()
-    {
-        $this->setName(self::NAME)
-             ->setDescription(
-                 $this->translator->translate('Generates a short code for provided URL and returns the short URL')
-             )
-             ->addArgument('longUrl', InputArgument::REQUIRED, $this->translator->translate('The long URL to parse'))
-             ->addOption(
-                 'tags',
-                 't',
-                 InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED,
-                 $this->translator->translate('Tags to apply to the new short URL')
-             )
-             ->addOption('validSince', 's', InputOption::VALUE_REQUIRED, $this->translator->translate(
-                 'The date from which this short URL will be valid. '
-                 . 'If someone tries to access it before this date, it will not be found.'
-             ))
-             ->addOption('validUntil', 'u', InputOption::VALUE_REQUIRED, $this->translator->translate(
-                 'The date until which this short URL will be valid. '
-                 . 'If someone tries to access it after this date, it will not be found.'
-             ))
-             ->addOption('customSlug', 'c', InputOption::VALUE_REQUIRED, $this->translator->translate(
-                 'If provided, this slug will be used instead of generating a short code'
-             ))
-             ->addOption('maxVisits', 'm', InputOption::VALUE_REQUIRED, $this->translator->translate(
-                 'This will limit the number of visits for this short URL.'
-             ));
-    }
-
-    public function interact(InputInterface $input, OutputInterface $output)
-    {
-        $io = new SymfonyStyle($input, $output);
-        $longUrl = $input->getArgument('longUrl');
-        if (! empty($longUrl)) {
-            return;
-        }
-
-        $longUrl = $io->ask(
-            $this->translator->translate('A long URL was not provided. Which URL do you want to be shortened?')
-        );
-        if (! empty($longUrl)) {
-            $input->setArgument('longUrl', $longUrl);
-        }
-    }
-
-    public function execute(InputInterface $input, OutputInterface $output)
-    {
-        $io = new SymfonyStyle($input, $output);
-        $longUrl = $input->getArgument('longUrl');
-        if (empty($longUrl)) {
-            $io->error($this->translator->translate('A URL was not provided!'));
-            return;
-        }
-
-        $tags = $input->getOption('tags');
-        $processedTags = [];
-        foreach ($tags as $key => $tag) {
-            $explodedTags = \explode(',', $tag);
-            $processedTags = \array_merge($processedTags, $explodedTags);
-        }
-        $tags = $processedTags;
-        $customSlug = $input->getOption('customSlug');
-        $maxVisits = $input->getOption('maxVisits');
-
-        try {
-            $shortCode = $this->urlShortener->urlToShortCode(
-                new Uri($longUrl),
-                $tags,
-                $this->getOptionalDate($input, 'validSince'),
-                $this->getOptionalDate($input, 'validUntil'),
-                $customSlug,
-                $maxVisits !== null ? (int) $maxVisits : null
-            );
-            $shortUrl = (new Uri())->withPath($shortCode)
-                                   ->withScheme($this->domainConfig['schema'])
-                                   ->withHost($this->domainConfig['hostname']);
-
-            $io->writeln([
-                \sprintf('%s <info>%s</info>', $this->translator->translate('Processed long URL:'), $longUrl),
-                \sprintf('%s <info>%s</info>', $this->translator->translate('Generated short URL:'), $shortUrl),
-            ]);
-        } catch (InvalidUrlException $e) {
-            $io->error(\sprintf(
-                $this->translator->translate('Provided URL "%s" is invalid. Try with a different one.'),
-                $longUrl
-            ));
-        } catch (NonUniqueSlugException $e) {
-            $io->error(\sprintf(
-                $this->translator->translate(
-                    'Provided slug "%s" is already in use by another URL. Try with a different one.'
-                ),
-                $customSlug
-            ));
-        }
-    }
-
-    private function getOptionalDate(InputInterface $input, string $fieldName)
-    {
-        $since = $input->getOption($fieldName);
-        return $since !== null ? new \DateTime($since) : null;
-    }
-}

module/CLI/src/Command/Shortcode/GetVisitsCommand.php

@@ -1,110 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
-
-use Shlinkio\Shlink\Common\Util\DateRange;
-use Shlinkio\Shlink\Core\Service\VisitsTrackerInterface;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputArgument;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
-
-class GetVisitsCommand extends Command
-{
-    const NAME = 'shortcode:visits';
-
-    /**
-     * @var VisitsTrackerInterface
-     */
-    private $visitsTracker;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
-
-    public function __construct(VisitsTrackerInterface $visitsTracker, TranslatorInterface $translator)
-    {
-        $this->visitsTracker = $visitsTracker;
-        $this->translator = $translator;
-        parent::__construct();
-    }
-
-    public function configure()
-    {
-        $this->setName(self::NAME)
-            ->setDescription(
-                $this->translator->translate('Returns the detailed visits information for provided short code')
-            )
-            ->addArgument(
-                'shortCode',
-                InputArgument::REQUIRED,
-                $this->translator->translate('The short code which visits we want to get')
-            )
-            ->addOption(
-                'startDate',
-                's',
-                InputOption::VALUE_OPTIONAL,
-                $this->translator->translate('Allows to filter visits, returning only those older than start date')
-            )
-            ->addOption(
-                'endDate',
-                'e',
-                InputOption::VALUE_OPTIONAL,
-                $this->translator->translate('Allows to filter visits, returning only those newer than end date')
-            );
-    }
-
-    public function interact(InputInterface $input, OutputInterface $output)
-    {
-        $shortCode = $input->getArgument('shortCode');
-        if (! empty($shortCode)) {
-            return;
-        }
-
-        $io = new SymfonyStyle($input, $output);
-        $shortCode = $io->ask(
-            $this->translator->translate('A short code was not provided. Which short code do you want to use?')
-        );
-        if (! empty($shortCode)) {
-            $input->setArgument('shortCode', $shortCode);
-        }
-    }
-
-    public function execute(InputInterface $input, OutputInterface $output)
-    {
-        $io = new SymfonyStyle($input, $output);
-        $shortCode = $input->getArgument('shortCode');
-        $startDate = $this->getDateOption($input, 'startDate');
-        $endDate = $this->getDateOption($input, 'endDate');
-
-        $visits = $this->visitsTracker->info($shortCode, new DateRange($startDate, $endDate));
-        $rows = [];
-        foreach ($visits as $row) {
-            $rowData = $row->jsonSerialize();
-            // Unset location info
-            unset($rowData['visitLocation']);
-
-            $rows[] = \array_values($rowData);
-        }
-        $io->table([
-            $this->translator->translate('Referer'),
-            $this->translator->translate('Date'),
-            $this->translator->translate('Remote Address'),
-            $this->translator->translate('User agent'),
-        ], $rows);
-    }
-
-    protected function getDateOption(InputInterface $input, $key)
-    {
-        $value = $input->getOption($key);
-        if (! empty($value)) {
-            $value = new \DateTime($value);
-        }
-
-        return $value;
-    }
-}

module/CLI/src/Command/Shortcode/ListShortcodesCommand.php

@@ -1,144 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
-
-use Shlinkio\Shlink\Common\Paginator\Adapter\PaginableRepositoryAdapter;
-use Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait;
-use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
-
-class ListShortcodesCommand extends Command
-{
-    use PaginatorUtilsTrait;
-
-    const NAME = 'shortcode:list';
-
-    /**
-     * @var ShortUrlServiceInterface
-     */
-    private $shortUrlService;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
-
-    public function __construct(ShortUrlServiceInterface $shortUrlService, TranslatorInterface $translator)
-    {
-        $this->shortUrlService = $shortUrlService;
-        $this->translator = $translator;
-        parent::__construct();
-    }
-
-    public function configure()
-    {
-        $this->setName(self::NAME)
-             ->setDescription($this->translator->translate('List all short URLs'))
-             ->addOption(
-                 'page',
-                 'p',
-                 InputOption::VALUE_OPTIONAL,
-                 sprintf(
-                     $this->translator->translate('The first page to list (%s items per page)'),
-                     PaginableRepositoryAdapter::ITEMS_PER_PAGE
-                 ),
-                 1
-             )
-             ->addOption(
-                 'searchTerm',
-                 's',
-                 InputOption::VALUE_OPTIONAL,
-                 $this->translator->translate(
-                     'A query used to filter results by searching for it on the longUrl and shortCode fields'
-                 )
-             )
-             ->addOption(
-                 'tags',
-                 't',
-                 InputOption::VALUE_OPTIONAL,
-                 $this->translator->translate('A comma-separated list of tags to filter results')
-             )
-             ->addOption(
-                 'orderBy',
-                 'o',
-                 InputOption::VALUE_OPTIONAL,
-                 $this->translator->translate(
-                     'The field from which we want to order by. Pass ASC or DESC separated by a comma'
-                 )
-             )
-             ->addOption(
-                 'showTags',
-                 null,
-                 InputOption::VALUE_NONE,
-                 $this->translator->translate('Whether to display the tags or not')
-             );
-    }
-
-    public function execute(InputInterface $input, OutputInterface $output)
-    {
-        $io = new SymfonyStyle($input, $output);
-        $page = (int) $input->getOption('page');
-        $searchTerm = $input->getOption('searchTerm');
-        $tags = $input->getOption('tags');
-        $tags = ! empty($tags) ? \explode(',', $tags) : [];
-        $showTags = $input->getOption('showTags');
-
-        do {
-            $result = $this->shortUrlService->listShortUrls($page, $searchTerm, $tags, $this->processOrderBy($input));
-            $page++;
-
-            $headers = [
-                $this->translator->translate('Short code'),
-                $this->translator->translate('Original URL'),
-                $this->translator->translate('Date created'),
-                $this->translator->translate('Visits count'),
-            ];
-            if ($showTags) {
-                $headers[] = $this->translator->translate('Tags');
-            }
-
-            $rows = [];
-            foreach ($result as $row) {
-                $shortUrl = $row->jsonSerialize();
-                if ($showTags) {
-                    $shortUrl['tags'] = [];
-                    foreach ($row->getTags() as $tag) {
-                        $shortUrl['tags'][] = $tag->getName();
-                    }
-                    $shortUrl['tags'] = implode(', ', $shortUrl['tags']);
-                } else {
-                    unset($shortUrl['tags']);
-                }
-
-                $rows[] = \array_values($shortUrl);
-            }
-            $io->table($headers, $rows);
-
-            if ($this->isLastPage($result)) {
-                $continue = false;
-                $io->success($this->translator->translate('Short codes properly listed'));
-            } else {
-                $continue = $io->confirm(
-                    \sprintf($this->translator->translate('Continue with page') . ' <options=bold>%s</>?', $page),
-                    false
-                );
-            }
-        } while ($continue);
-    }
-
-    private function processOrderBy(InputInterface $input)
-    {
-        $orderBy = $input->getOption('orderBy');
-        if (empty($orderBy)) {
-            return null;
-        }
-
-        $orderBy = explode(',', $orderBy);
-        return count($orderBy) === 1 ? $orderBy[0] : [$orderBy[0] => $orderBy[1]];
-    }
-}

module/CLI/src/Command/Shortcode/ResolveUrlCommand.php

@@ -1,81 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
-
-use Shlinkio\Shlink\Core\Exception\EntityDoesNotExistException;
-use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
-use Shlinkio\Shlink\Core\Service\UrlShortenerInterface;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputArgument;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
-
-class ResolveUrlCommand extends Command
-{
-    const NAME = 'shortcode:parse';
-
-    /**
-     * @var UrlShortenerInterface
-     */
-    private $urlShortener;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
-
-    public function __construct(UrlShortenerInterface $urlShortener, TranslatorInterface $translator)
-    {
-        $this->urlShortener = $urlShortener;
-        $this->translator = $translator;
-        parent::__construct(null);
-    }
-
-    public function configure()
-    {
-        $this->setName(self::NAME)
-             ->setDescription($this->translator->translate('Returns the long URL behind a short code'))
-             ->addArgument(
-                 'shortCode',
-                 InputArgument::REQUIRED,
-                 $this->translator->translate('The short code to parse')
-             );
-    }
-
-    public function interact(InputInterface $input, OutputInterface $output)
-    {
-        $shortCode = $input->getArgument('shortCode');
-        if (! empty($shortCode)) {
-            return;
-        }
-
-        $io = new SymfonyStyle($input, $output);
-        $shortCode = $io->ask(
-            $this->translator->translate('A short code was not provided. Which short code do you want to parse?')
-        );
-        if (! empty($shortCode)) {
-            $input->setArgument('shortCode', $shortCode);
-        }
-    }
-
-    public function execute(InputInterface $input, OutputInterface $output)
-    {
-        $io = new SymfonyStyle($input, $output);
-        $shortCode = $input->getArgument('shortCode');
-
-        try {
-            $longUrl = $this->urlShortener->shortCodeToUrl($shortCode);
-            $output->writeln(\sprintf('%s <info>%s</info>', $this->translator->translate('Long URL:'), $longUrl));
-        } catch (InvalidShortCodeException $e) {
-            $io->error(
-                \sprintf($this->translator->translate('Provided short code "%s" has an invalid format.'), $shortCode)
-            );
-        } catch (EntityDoesNotExistException $e) {
-            $io->error(
-                \sprintf($this->translator->translate('Provided short code "%s" could not be found.'), $shortCode)
-            );
-        }
-    }
-}

module/CLI/src/Command/Tag/CreateTagCommand.php

@@ -3,58 +3,52 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\Command\Tag;
 
+use Shlinkio\Shlink\CLI\Util\ExitCodes;
 use Shlinkio\Shlink\Core\Service\Tag\TagServiceInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Zend\I18n\Translator\TranslatorInterface;
 
 class CreateTagCommand extends Command
 {
-    const NAME = 'tag:create';
+    public const NAME = 'tag:create';
 
-    /**
-     * @var TagServiceInterface
-     */
+    /** @var TagServiceInterface */
     private $tagService;
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
 
-    public function __construct(TagServiceInterface $tagService, TranslatorInterface $translator)
+    public function __construct(TagServiceInterface $tagService)
     {
-        $this->tagService = $tagService;
-        $this->translator = $translator;
         parent::__construct();
+        $this->tagService = $tagService;
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName(self::NAME)
-            ->setDescription($this->translator->translate('Creates one or more tags.'))
+            ->setDescription('Creates one or more tags.')
             ->addOption(
                 'name',
                 't',
                 InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                $this->translator->translate('The name of the tags to create')
+                'The name of the tags to create'
             );
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
         $io = new SymfonyStyle($input, $output);
         $tagNames = $input->getOption('name');
 
         if (empty($tagNames)) {
-            $io->warning($this->translator->translate('You have to provide at least one tag name'));
-            return;
+            $io->warning('You have to provide at least one tag name');
+            return ExitCodes::EXIT_WARNING;
         }
 
         $this->tagService->createTags($tagNames);
-        $io->success($this->translator->translate('Tags properly created'));
+        $io->success('Tags properly created');
+        return ExitCodes::EXIT_SUCCESS;
     }
 }