🫥 4.2.0 – Trancoso

Thanks a lot to @tobimori. and @ieteo for tracking down and fixing a nasty bug 🙏

Requires

Kirby 3.7.4 as latest release without known security issues - https://getkirby.com/security

Fixes

• 404 when trying to edit or remove path containing a slash #300

🍬 4.1.0 – Buenos Aires

Release 4.1.0 prepares Retour for Kirby 3.7 - it also requires it.
This allowed us to shave off some weight by using new core components.

If you use Kirby 3.6, please stick to Retour 4.0.0.

😶‍🌫️ 4.0.0 – Caracas

Code debt, COVID and Kirby 3.6 rendered Retour 3 flawed and unmaintained for the last months.

So here we are for a new start...

What's new?

• Requires Kirby 3.6.1 and higher

More reliable

• Rewritten PHP architecture and restructured folder setup
• Unit tests for PHP backend with 95+% coverage
• It all runs on Fiber (introduced in Kirby 3.6)! Which helps to move a lot of the logic to PHP and make it testable
• Removed experimental frontend parts
• New script to generate sample data
• Code quality checks (via psalm and phpmd)
• Removed automatic updater for config and log files (see below how to upgrade manually)
• Uses kirbyup instead of parcel for bundling

Better

• Panel: plugin assets are down to 27 kb from 79 kb (e.g. via native charts, dropping chartist library)
• Panel: improved UI of redirect route dialogs
• Panel: navigation bar now sits below the charts to communicate clearer that they it also affects the tables' data
• Panel: timeline cuts off at current day/month (instead of falling to 0 in the coming day/month)
• Panel: highlight current hour/day/month on timeline axis
• Permalinks for the Panel view
• Backend: supports JSON for config files (set via distantnative.retour.config option) as (faster) alternative

{
  "redirects": [
    {
      "from": "blog/(:all)",
      "to": "notes/$1",
      "status": 308,
      "priority": false
    },
    {
      "from": "team",
      "to": "about/team",
      "status": 307,
      "priority": true
    }
  ]
}

• New distant native.retour.site option to modify path prefix in Panel dialog
• Supports PHP 8.1

Fixed

• Problems that caused redirect routes config getting wiped
• More stable dialog for adding/editing routes with distinct ways to cancel or save
• Fixed de-activating logs
• Fixed remembering pagination setting
• Fixed adding fail as redirect route

Missing

To increase reliability, I had to drop a few features from previous versions (for now):

• Removed page picker from redirect route dialog
• Removed calendar/date-range dropdown
• Support for PHP 7.3

How to upgrade?

As always: Please make a backup before updating anything!

1. Rename your config file to site/config/retour.yml
   if you have not set your custom location via distantnative.retour.config.
2. Update your config file
   Array of redirect routes needs to be moved inside redirects key.

redirects:
  -
    from: blog/(:all)
    to: notes/$1
    status: 301
    priority: false
    comment: null
  -
    from: team
    to: about/team
    status: 307
    priority: true
    comment: null

If you want to switch to using JSON for the config file, rename your file to site/config/retour.json, convert the file content via an online tool and set the config option:

'distantnative.retour.config' => __DIR__ . '/retour.json'

❌ 3.0.0 – Squamish

❌ Unsupported
This release of Retour is not supported anymore and contains critical issues.
Please use a current release instead.

The next major version of Retour is coming here: 3.0 - Squamish.

Built on top of Kirby 3.5.0, several extensive re-writes and dead-ends have lead up to substantial changes to the code base of both backend and frontend of the plugin. Still usage and functionality should feel familiar.

What's new?

Routes (can) take priority

• Allow redirects that overwrite route for existing pages with new priority flag #161
• New comment field for redirect routes
• Non-final routes aren't counted in the stats anymore (prevents double counting language routes) #138

Redesigned Panel view

• Built on new UI components from Kirby 3.5 and from an alternative universe (storybook)
• Proper tabs, breadcrumbs, table component, drawer for editing
• Menu item now is called Redirects
• Better timeframe calendar dropdown
• Better graph axis labels
• Error notifications for failed API calls

Much more under the hood

• Support for callbacks as config options #149
• Improved API calls for better loading
• Uses the new logs root
• Massively improved database queries for logging and stats
• Stats were showing inaccurate data. Not anymore.
• Completely refactored backend code for better performance and maintainability
• API call errors are now caught and displayed in the Panel
• Introduced new update mechanism to allow config and database schema changes between versions

How to update

• Save a backup of site/config/redirects.yml and site/logs/retour.sqlite - really, please do!
• Replace site/plugins/retour with new version
• Move site/logs/retour.sqlite to site/logs/retour/log.sqlite (if you haven't used a custom location so far)

2.3.2

❌ Unsupported
This release of Retour is not supported anymore and contains critical issues.
Please use a current release instead.

• Enhanced: only track final routes
• Removed broken and unused update mechanism (better implementation to return in 3.0.0)

2.3.1

❌ Unsupported
This release of Retour is not supported anymore and contains critical issues.
Please use a current release instead.

• Fixed composer setups
• Safer database connection and queries

2.3.0

❌ Unsupported
This release of Retour is not supported anymore and contains critical issues.
Please use a current release instead.

• New website and full documentation
• Improved update script #132
• Fixed empty form submission #137
• Fixed localization of timeframe label #134
• Fixed responsiveness of headers #141
• Fixed start/end of day in stats
• Fixed location of database asset
• Got rid of timezone workaround #140
• Simplified localization strings
• Added absolute class names #131
• Code refactoring and cleaning
• Remove affiliate license sponsoring message
• Removed sample code

2.2.0

❌ Unsupported
This release of Retour is not supported anymore and contains critical issues.
Please use a current release instead.

• Added date interval picker to choose custom timeframes
• Charts respond to custom timeframe
• Tables respond to custom timeframe
• Improved responsiveness for timeline chart
• Updated timeline chart areas design
• Updated table switch design
• Remove recency indicator from tables
• Fixed including clean sqlite database file
• Fixed update check

2.1.1

❌ Unsupported
This release of Retour is not supported anymore and contains critical issues.
Please use a current release instead.

• Added option distantnative.retour.ignore to ignore paths #116
• Added option distantnative.retour.updated to change update flag file location #123
• Fixed page picker for redirects #117
• Fixed including sqlite asset when downloading #124
• Fixed creating logs directory if not exists #119
• Fixed toArray() when no records found #120

2.1.0

❌ Unsupported
This release of Retour is not supported anymore and contains critical issues.
Please use a current release instead.

• Requires Kirby 3.3
• Added option to disable logs distantnative.retour.logs
• Implemented upgrade functionality for future updates
• Using CSS vars from the core
• Improved mobile responsiveness