Retour

Added

• Added the Resolve Craft Sites setting to allow user control over whether Craft sites should be factored in to destination URLs (#334)
• Added validation on Short Link fields so you cannot create one if the Short Link already exists at that URL (#340)

Changed

• Only look at adding site prefixes to pathonly redirects via GraphQL

Fixed

• Fixed an issue with Postgres throwing a PDOException (#336)

Fixed

• Fixed an issue where redirects with a path site prefix were processed in the wrong order, and might not work as expected
• Fixed a logic error where query parameters with duplicate values could be removed from the resulting destination URL
• Destination URLs are no longer URL decoded unless a malicious payload was stripped from them (#330)

Changed

• Update buildchain to Vite 6 & Tailwind CSS 4

Fixed

• Fixed an issue where query strings and fragments could be stripped from the destination URL (#327)

Fixed

• Fixed an issue where redirects were not, in fact, redirecting with the appropriate site URL prefix as expected (#325)

Changed

• Fixed an issue where a GraphQL Retour query could return a URL with a / prefixed to it if the destination was a full URL (#320)

Changed

• Retour now strips site path prefixes from incoming 404 URL paths, such that redirects will work as expected (any Site sub-path prefix is ignored) (#288)
• Don't create automatic redirects for elements that are not enabled

Fixed

• Fixed an issue where 410 Gone redirects returned a generic browser error rather than a custom-defined Craft template (#11)
• Fixed an issue where an exception could be thrown if a Site had no baseUrl defined
• Normalize the incoming url and path so that mergUrlWithPath() handles edge-cases properly (#1512)
• Fixed an issue where deprecation errors would occur when an element does not have a uri (#317)

Fixed

• Fixed an issue where the "File Not Found URL" link could be wrong when clicked on in some multi-site setups (#310)

Added

• Separate out the plugin settings into General, Statistics, and Advanced tabs
• Added a Set No-Cache Headers setting (defaulting to on) to set no-cache headers on the redirect response to prevent client-side caching (#306)

Changed

• When saving a redirect, Retour no longer deletes redirects that have the redirectDestUrl of the redirect being saved as their redirectSrcUrl (#303)

Fixed

• Fixed an issue where the down and up arrows were reversed for sorting purposes (#299)
• Fixed an issue where the "File Not Found URL" link could be wrong when clicked on in some multi-site setups (#290)
• Fixed an issue where the Short Link wouldn't display properly in the element index view (#301)
• Fixed an issue where Short Links wouldn't work properly if they were added to Asset elements (#300)
• Fixed an issue where a "Integrity constraint violation" error could occurr if malformed redirectSrcUrls was introduced into the statistics table (#305)

Fixed

• Added the unused static to the Tailwind CSS blocklist to avoid a name collision with a Craft CSS class (#1412)
• Fixed an issue with impropertly text-encoded characters in URLs potentially causing a db exception (#291)
• Fixed an issue where an empty redirect in the excludePatterns list could cause redirects to stop functioning, add logging when a redirect is excluded (#297)

Added

• Add phpstan and ecs code linting
• Add code-analysis.yaml GitHub action

Changed

• Switch over to Vite ^5.0.0 & Node ^20.0.0 for the buildchain
• Updated docs to use node 20 & a new sitemap plugin
• PHPstan code cleanup
• ECS code cleanup

Fixed

• Fixed an issue that could cause an exception to be thrown if the Preserve Query String setting is on
• Fixed an issue where the filter controls didn't work properly for Short Links

Fixed

• Fixes issue where only first line of uploaded CSV is saved in cache in load balanced environment (#286)
• Strip off a leading / before making a site URL from a path, because otherwise Craft.getUrl() considers it an absolute URL and returns it (#281)

Added

• Add db index for redirectMatchType to help with query performance (#282)

Changed

• Add permission fallback logic to the dashboard for Short Links access

Security

• Fixed a potential XSS vulnerability with a malformed referrer header

Changed

• Enforce full URL matching for short links when used within a multi-site setup and enabling any of the content translation method for the field. (#277)

Fixed

• Fixed a bug where short links would not work correctly within Matrix fields. (#279)
• Fixed a bug where short links would not be cleaned up appropriately when updating a Short Link value on an element. (#277)
• Fixed a bug where short links would not work correctly with multi-sites. (#277)

Added

• Added the ability to disable statistics recording entirely via enableStatistics in the config.php (#272)

Changed

• Add versioning to the docs

Fixed

• Fixed an issue where no events triggered when using exactMatch redirect (#273)
• Fixed a bug where deleting a revision would also delete all the short links associated with the element (#270)

Changed

• Use dynamic docker container name & port for the buildchain
• Update the buildchain to use Vite ^4.0.0
• Refactored the docs buildchain to use a dynamic docker container setup

Fixed

• Fixed an issue with the rebuild indexes migration (#269)

Fixed

• Added missing priority column to the retour_static_redirects too, in Install.php migration (#262)

Fixed

• Added missing priority column to the Install.php migration (#262)

Added

• Added the ability to set a Priority for regex redirects, so you have control over the order in which they execute (#74)

Fixed

• Fixed an issue that would cause getStaticRedirect() to return a redirect regardless of whether or not it is enabled (#260)

Added

• Added EVENT_BEFORE_DELETE_REDIRECT & EVENT_AFTER_DELETE_REDIRECT events, so you can hook in before & after a redirect is deleted (#259)

Changed

• Updated docs to use VitePress ^1.0.0-alpha.29

Fixed

• Fixed an issue with the console command throwing an exception due to an uninitialized typed property (#257)

Changed

• Fixed HMR in local dev with explicit alias that resolves to the actual directory
• Add import.meta.hot.accept for entrypoint JavaScript for HMR

Fixed

• Fixed an issue where the default value for redirectHttpCode would cause a validation error to be displayed when creating a new static redirect (#255)
• Fixed an issue where the default value for redirectHttpCode would cause importing a CSV file to fail if no redirectHttpCode was provided in the CSV file (#253)

Changed

• Move to using ServicesTrait and add getter methods for services
• Users must have permission to access Retour to be able to use the Retour widget (#251)

Fixed

• Ensure that $driver is nullable in the install migration (#252) (#250)

Changed

• Fixed an issue where element types that update their uriFormat directly rather than re-saving the elements will generate automatic element redirects (#248)
• Updated how Retour's components are registered, to allow for overriding via plugin config (#1989) (#11039)
• Update the buildchain to use Vite ^3.1.0 for building frontend assets

Changed

• Whether a Short Link redirect is created for "All Sites" or on a per-site basis is now determined by the propagation method of the Short Link field
• Include "Short Link Element ID" in the CSV redirects export
• Allow for the localization of the exported redirects & statistics column names

Fixed

• Fix improperly named field input template (casing) (#247)
• Editing a Short Link field's redirect in the CP now properly preserves its Short Link status, and redirects to the Short Links page

Fixed

• Fixed an issue that could cause redirects to not function as expected (#245)

Added

• Added the Short Link field type that allows content authors to add short link redirects in an entry
• Added translations in the Javascript views that Retour uses, allowing for better localization (#222)
• If a CSV import has errors, they are displayed on the frontend to make them easier to diagnose (#219)

Changed

• Improved the performance when resolving exact match redirects by doing a database query. (#217)
• If the Preserve Query String plugin setting is enabled, query strings from the incoming request and the destination URL will be combined (#242)

Changed

• Removed the sub resource integrity on the built JavaScript, which could fail if systems were set up that manipulated the incoming JavaScript resources dynamically (#229)

Fixed

• Fixed a "must not be accessed before initialization" error that could occur using GraphQL (#238)

Added

• Initial release for Craft CMS 4

Fixed

• Fixed an issue where the Dashboard didn't property narrow results down to the selected site, due to moreParams being saved in the object state (#236)
• Fixed an issue where the Redirects didn't property narrow results down to the selected site, due to moreParams being saved in the object state (#235)

Changed

• No longer trim / from URLs that are presented in the Retour Dashboard (#227)
• Remove deprecated CraftQL support
• Remove unneeded feature checks based on Craft 3.x versions

Fixed

• Fixed an issue where an exception could be thrown in production due to incompatible types

Fixed

• Fix registering permissions (#224)

Fixed

• Updated types for Craft CMS 4.0.0-alpha.1 via Rector

Added

• Initial Craft CMS 4 compatibility