shlinkio/shlink

The definitive self-hosted URL shortener

shlink's Issues

Remove dependency on expressive helpers package.

Translate application literals

How to set the language:

• CLI -> Read it from local configuration
• Rest and Web (404) -> Use Accept-Language header (via specific middleware) and fallback to local config if not provided

Create a command to generate a short code charset by randomizing the default one

Name: config:generate-charset

Create a web front-end with AngularJS

https://github.com/shlinkio/shlink-web-client

Add missing htaccess file for apache environments

Make CLI commands to use the same PHP namespace as the one used for the command name

Allow to limit the number of visits to a short code

Once the limit has been reached, the server will return a 404 Not Found as if the short code was invalid

Add support for other cache adapters by improving the Cache factory

Add logger and log errors

Use monolog

Change the visits-visit_locations relation from one-to-many to many-to-many

This will prevent the same IP address to be processed more than once

Consider allowing to set custom slugs instead of generating a short code

Improve code coverage

Add support for other database management systems by improving the EntityManager factory

Generate build process to paquetize the app and ease distribution

Installation steps

• Define ENV vars in apache or nginx:
  • SHORTENED_URL_SCHEMA: http|https
  • SHORTENED_URL_HOSTNAME: Short domain
  • SHORTCODE_CHARS: The char set used to generate short codes (defaults to 123456789bcdfghjkmnpqrstvwxyzBCDFGHJKLMNPQRSTVWXYZ, but a new one can be generated with the config:generate-charset command)
  • DB_USER: MySQL database user
  • DB_PASSWORD: MySQL database password
  • REST_USER: Username for REST authentication
  • REST_PASSWORD: Password for REST authentication
  • DB_NAME: MySQL database name (defaults to shlink)
  • DEFAULT_LOCALE: Language in which web requests (browser and REST) will be returned if no Accept-Language header is sent (defaults to en)
  • CLI_LOCALE: Language in which console command messages will be displayed (defaults to en)
• Create database (vendor/bin/doctrine orm:schema-tool:create)
• Add write permissions to data directory
• Create doctrine proxies (vendor/bin/doctrine orm:generate-proxies)
• Create symlink to bin/cli as shlink in /usr/local/bin (linux only. Optional)

Supported languages: es and en

Add website previews while listing available URLs

Use wkhtmltoimage and a wrapper library:

• http://wkhtmltopdf.org/index.html
• https://github.com/mikehaertl/phpwkhtmltopdf

Update the vendor and app namespace from Acelaya\UrlShortener to Shlinkio\Shlink

Prevent duplicated shortcodes errors because of the case insensitive behavior on MySQL

Create a REST API

• Endpoints
  • Create shortcode (returns the generated URL)
  • Get long URL from short code
  • List shortened URLs
  • Get visits on certain URL by short code
• Authentication: Very basic. Generate token based on user/password
• Return cross-domain headers for web clients
  • Access-Control-Allow-Origin
  • Access-Control-Allow-Methods
  • Access-Control-Max-Age
  • Access-Control-Allow-Headers
• Create documentation
• Paginate results on list requests

Inject cross domain headers in response only if the Origin header is present in the request

Add more CLI functionality

• Get long URL from short code
• List shortened URLs
• Get visits on certain URL by short code

Separate code into multiple modules

• Shlinkio\Shlink\Common
• Shlinkio\Shlink\Core
• Shlinkio\Shlink\Rest
• Shlinkio\Shlink\CLI

Replace "Middleware" suffix on routable middlewares by "Action"

Allow to define tags on short codes, to improve filtering and classification

Create CHANGELOG file

Group routable middleware in an Action namespace

Improve REST authentication

Using something like oAuth seems a little bit overengineered for this app.
JSON web tokens could be an option https://jwt.io/introduction/

Also drop the username/password system and use API keys that are generated from the command line and persisted in the database.
Allow to disable any API key or set expiration dates.
In the future, this will allow to set an ACL system

Use the acelaya/ze-content-based-error-handler package instead of custom error handler implementation

Save visits locations data on a visit_locations table

Use the package https://github.com/chrislim2888/IP2Location-PHP-Module

Define a route that returns a QR code representing the shortened URL

For example, if the URL is http://doma.in/abc123, the QR code URL would be http://doma.in/qr/abc123, and the generated QR code will point to the first one.
The QR code should be cached once generated.

Allow to limit short codes availability by date range

Outside of the date range, the server will return a 404 Not Found as if the short code was invalid

Use symfony/console to dispatch console requests, instead of trying to integrate the process with expressive

Change copyright from "Alejandro Celaya" to "Shlink" in error pages

Add repository functional tests with dbunit

Consider moving every module to a different repository and composer package

I think it will only make sense to separate the Common module.
Probably the error handler stuff could live on its own package because it is very useful and very reusable.

Define installation script. It will request dynamic data on the fly so that there is no need to define env vars

Replace the "services" first level config entry by "dependencies", in order to fulfill default Expressive name

Cache the "short code" => "URL" map to prevent extra DB hits

Use current Cache adapter

Return JSON/HTML responses for errors (4xx and 5xx) based on accept header (content negotiation)

• Use a custom error handler to check the Accept header.
• Also create a middleware for rest that is executed with low priority and returns a 404 with JSON body

Allow to filter visits by date range

If date range is not provided, return the first 2 days since the short code was created.

Take into account the X-Forwarded-For header in order to get the visitor information, in case the server is behind a load balancer or proxy

Add "Create process:visits cron" to installation steps

Consider saving metadata along with the long URL behind a short code

Fix entities database interoperability

• SQLite -> COLLATION: BINARY
• MySQL -> COLLATION: utf8_bin
• PostgreSQL -> Seems to be case sensitive by default

Create an AbstractTranslatableCommand from which other commands extend

It should wrapps the translator and define a --lang falg in order to set the language at runtime

Remove hhvm from the CI matrix since it doesn't support array constants and will fail

Create a web analytics section

Make REST endpoints that need to find something return a 404 when "something" is not found

Improve error management

Inject a logger in the ContentBasedErrorHandler and log errors.