Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmkebusinessgmbh/typo3-mk30xlegacy
Automatic redirects to legacy/mirror/stale environment.
https://github.com/dmkebusinessgmbh/typo3-mk30xlegacy
automation composer php redirects typo3 typo3-extension
Last synced: 3 days ago
JSON representation
Automatic redirects to legacy/mirror/stale environment.
- Host: GitHub
- URL: https://github.com/dmkebusinessgmbh/typo3-mk30xlegacy
- Owner: DMKEBUSINESSGMBH
- Created: 2022-02-08T14:53:01.000Z (almost 3 years ago)
- Default Branch: 11.5
- Last Pushed: 2023-09-08T11:34:29.000Z (over 1 year ago)
- Last Synced: 2024-10-31T03:52:56.486Z (3 months ago)
- Topics: automation, composer, php, redirects, typo3, typo3-extension
- Language: PHP
- Homepage: https://www.dmk-ebusiness.de
- Size: 73.2 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Mk 30x Legacy Redirects
=======================
[](https://packagist.org/packages/dmk/mk30xlegacy)
[](https://packagist.org/packages/dmk/mk30xlegacy)
[](https://github.com/DMKEBUSINESSGMBH/typo3-mk30xlegacy/actions?query=workflow%3A%22PHP+Checks%22)
[](https://github.com/DMKEBUSINESSGMBH/typo3-mk30xlegacy/actions?query=workflow%3A%22PHP+Checks%22)
[](https://packagist.org/packages/dmk/mk30xlegacy)
This TYPO3 extension performs automatic redirects to a legacy domain
if the requested uri was not found at the TYPO3.
## What it does in short:
* Registers a middleware.
* Checks the TYPO3 response for unavailable status code.
* asks matchers for the uri to the new or old source to redirect to
* PageTypeSuffixRemovalMatcher:
Checks whether the url has a suffix and whether the url exists without an ending.
(Core SiteMatcher finds the uri or a HEAD request returns 200 status code).
* LegacyUriMatcher:
Checks if the request uri is available at the legacy domain
(returns 200 status code on HEAD request).
* Performs a redirect to the new uri.
## Installation
Install TYPO3 via composer.
From project root you need to run
```
composer require dmk/mk30xlegacy
```
## Configuration
The base configuration is done by extension configuration.
Use The _Admin Tools > Settings > Configure Extensions_ module to configure mk30xlegacy.
The configuration can be overridden by site configuration
or site language configuration.
Use the _Site Management > Sites_ module to configure the extension.
* **enabled**
Enables the legacy redirect middleware.
_(default: 1)_
* **responseMatchPattern**
Response match pattern:
Regex to match with current request http response code
to perform legacy redirect.
_(default: [345]\d\d)_
* **suffixRemovalSuffixes**
Page Type Suffixes: A comma seperated list of suffixes to remove from request uri.
_(default: html,htm,xhtml)_
* **redirectDomain**
Redirect Domain: Domain to performe the legacy redirect to.
* **redirectDomainAvailabilityMatchPattern**
Legacy availability match pattern:
Regex to match with http response code from legacy check.
On match a redirect to legacy domain will be performed.
_(default: 2\d\d)_
* **redirectResponseStatusCode**
Redirect Response HTTP-Status-Code:
The HTTP-Status Code used for redirects to legacy domain.
_(default: 307)_
## Add Custom Matcher
The redirect middleware uses a matcher registry, so custom matchers can be developed.
```php
class CustomMatcher implements MatcherInterface
{
public function isMatchableResponse(ResponseInterface $response): bool
{
// check here if this matcher is enabled for the typo3 response!
return true;
}
public function matchRequest(ServerRequestInterface $request, ResponseInterface $response): UriResult
{
$result = new UriResult();
// add your custom stuff here,
// to create an uri result (for redirect)
// depending on the request and response
return $result
}
}
```
Add the custom matcher in your `Services.yaml`:
```yaml
DMK\MyAwesomeExtension\Routing\Matcher\CustomMatcher:
tags:
-
name: 'mk30xlegacy.routing.matcher'
priority: 100
```
## Custom legacy uri manipulation
You can register an event listener before the availability check
of the LegacyUriMatcher is performed, to manipulate the legacy url by your own
_(we recommend to use a custom matcher instead!)_:
```php
class LegacyUriMatchEventListener
{
public function __invoke(UriMatchPreAvailabilityCheckEvent $event): void
{
$uri = $event->getResult()->getUri();
// manipulate the url here, add query parameters for example.
$uri = $uri->withQuery('?legacy=redirect&'.$uri->getQuery());
$event->getResult()->setUri($uri);
}
}
```
Add the custom listener in your `Services.yaml`:
```yaml
services:
DMK\MyAwesomeExtension\Event\EventListener\LegacyUriMatchEventListener:
tags:
-
name: 'event.listener'
identifier: 'MyAwesomeLegacyUriMatchEventListener'
event: DMK\Mk30xLegacy\System\Event\UriMatchPreAvailabilityCheckEvent
```