psr7-middlewares

Collection of PSR-7 middlewares.

Requirements

PHP >= 5.5
A PSR-7 HTTP Message implementation, for example zend-diactoros
A PSR-7 middleware dispatcher compatible with the following signature:

use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

function (RequestInterface $request, ResponseInterface $response, callable $next) {
    // ...
}

So, you can use these midlewares with:

Instalation

This package is installable and autoloadable via Composer as oscarotero/psr7-middlewares.

$ composer require oscarotero/psr7-middlewares

Usage example:

use Psr7Middlewares\Middleware;

use Relay\RelayBuilder;
use Zend\Diactoros\Response;
use Zend\Diactoros\ServerRequestFactory;
use Zend\Diactoros\Stream;

//Set a stream factory used by some middlewares
//(Required only if Zend\Diactoros\Stream is not detected)
Middleware::setStreamFactory(function ($file, $mode) {
    return new Stream($file, $mode);
});

//Create a relay dispatcher and add some middlewares:
$relay = new RelayBuilder();

$dispatcher = $relay->newInstance([

    //Calculate the response time
    Middleware::responseTime(),

    //Add an Uuid to request
    Middleware::uuid(),

    //Minify the result
    Middleware::minify(),

    //Adds the php debug bar
    Middleware::debugBar(),
    
    //Handle errors
    Middleware::errorHandler('error_handler_function')->catchExceptions(true),

    //Override the method using X-Http-Method-Override header
    Middleware::methodOverride(),

    //Removes www subdomain
    Middleware::www(false)->redirect(301),

    //Block search engines robots indexing
    Middleware::robots(),

    //Geolocation
    Middleware::geolocate(),

    //Detect client device
    Middleware::detectDevice(),

    //Parse the request payload
    Middleware::payload(),

    //Remove the path prefix
    Middleware::basePath('/my-site/web'),

    //Remove the trailing slash
    Middleware::trailingSlash(),

    //Digest authentication
    Middleware::digestAuthentication(['username' => 'password']),

    //Get the client ip
    Middleware::clientIp(),

    //Allow only some ips
    Middleware::firewall(['127.0.0.*']),

    //Detects the user preferred language
    Middleware::languageNegotiator(['gl', 'es', 'en']),

    //Detects the format
    Middleware::formatNegotiator(),

    //Execute fast route
    Middleware::fastRoute($app->get('dispatcher')),
]);

$response = $dispatcher(ServerRequestFactory::fromGlobals(), new Response());

Available middlewares

AccessLog
AttributeMapper
AuraRouter
AuraSession
BasePath
BasicAuthentication
BlockSpam
Cache
ClientIp
Cors
Csp
Csrf
DebugBar
Delay
DetectDevice
DigestAuthentication
EncodingNegotiator
ErrorHandler
FastRoute
FormTimestamp
Firewall
FormatNegotiator
Geolocate
GoogleAnalytics
Honeypot
Https
ImageTransformer
LanguageNegotiation
LeagueRoute
MethodOverride
Minify
Payload
PhpSession
Piwik
ReadResponse
Recaptcha
Rename
ResponseTime
Robots
SaveResponse
Shutdown
TrailingSlash
Uuid
Whoops
Www

AccessLog

To generate access logs for each request using the Apache's access log format. This middleware requires a Psr log implementation, for example monolog:

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\AuraRouter;
use Monolog\Logger;
use Monolog\Handler\ErrorLogHandler;

//Create the logger
$logger = new Logger('access');
$logger->pushHandler(new ErrorLogHandler());

//Add to the dispatcher
$dispatcher = $relay->getInstance([

    //Required to get the Ip
    Middleware::ClientIp(),

    Middleware::AccessLog($logger) //Instance of Psr\Log\LoggerInterface
        ->combined(true)           //(optional) To use the Combined Log Format instead the Common Log Format
]);

AttributeMapper

Maps middleware specific attribute to regural request attribute under desired name:

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::BasicAuthentication([
            'username1' => 'password1',
            'username2' => 'password2'
        ])
        ->realm('My realm'), //(optional) change the realm value
    
    Middleware::attributeMapper([
        Middleware\BasicAuthentication::KEY => 'auth:username'
    ]),
        
    function ($request, $response, $next) {
        $username = BasicAuthentication::getUsername($request);
    
        assert($username === $request->getAttribute('auth:username'));

        return $next($request, $response);
    }
]);

AuraRouter

To use Aura.Router (3.x) as a middleware:

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\AuraRouter;
use Aura\Router\RouterContainer;

//Create the router
$router = new RouterContainer();

$map = $router->getMap();

$map->get('hello', '/hello/{name}', function ($request, $response, $myApp) {

    //The route parameters are stored as attributes
    $name = $request->getAttribute('name');

    //You can get also the route instance
    $route = AuraRouter::getRoute($request);

    //Write directly in the response's body
    $response->getBody()->write('Hello '.$name);

    //or echo the output (it will be captured and writted into body)
    echo 'Hello world';

    //or return a string
    return 'Hello world';

    //or return a new response
    return $response->withStatus(200);
});

//Add to the dispatcher
$dispatcher = $relay->getInstance([

    Middleware::AuraRouter($router) //Instance of Aura\Router\RouterContainer
        ->arguments($myApp)         //(optional) append more arguments to the controller
]);

AuraSession

Creates a new Aura.Session instance with the request.

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\AuraSession;

$dispatcher = $relay->getInstance([

    Middleware::AuraSession(),
        ->factory($sessionFactory) //(optional) Intance of Aura\Session\SessionFactory
        ->name('my-session-name'), //(optional) custom session name

    function ($request, $response, $next) {
        //Get the session instance
        $session = AuraSession::getSession($request);

        return $response;
    }
]);

BasePath

Strip off the prefix from the uri path of the request. This is useful to combine with routers if the root of the website is in a subdirectory. For example, if the root of your website is /web/public, a request with the uri /web/public/post/34 will be converted to /post/34. You can provide the basePath to remove or let the middleware autodetect it.

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\BasePath;

$dispatcher = $relay->getInstance([
    Middleware::BasePath()
        ->basePath('/web/public') // (optional) The path to remove...
        ->autodetect(true),       // (optional) ...or autodetect the base path

    function ($request, $response, $next) {
        //Get the stripped off prefix
        $basePath = BasePath::getBasePath($request);

        return $response;
    }
]);

BasicAuthentication

Implements the basic http authentication. You have to provide an array with all users and password:

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::BasicAuthentication([
            'username1' => 'password1',
            'username2' => 'password2'
        ])
        ->realm('My realm'), //(optional) change the realm value
        
    function ($request, $response, $next) {
        $username = BasicAuthentication::getUsername($request);

        return $next($request, $response);
    }
]);

BlockSpam

To block referral spam usin the piwik/referrer-spam-blacklist list

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::BlockSpam('spammers.txt'), //(optional) to set a custom spammers list instead the piwik's list
]);

Cache

Uses micheh/psr7-cache. Saves the responses' headers in cache and returns a 304 response (Not modified) if the request is cached. It also adds Cache-Control and Last-Modified headers to the response. You need a cache library compatible with psr-6.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::Cache(new Psr6CachePool()) //the PSR-6 cache implementation
        ->cacheControl('max-age=3600'),    //(optional) to add this Cache-Control header to all responses
]);

ClientIp

Detects the client ip(s).

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\ClientIp;

$dispatcher = $relay->getInstance([

    Middleware::ClientIp()
        ->remote()  // (optional) Hack to get the ip from localhost environment
        ->headers([ // (optional) to change the trusted headers
            'Client-Ip',
            'X-Forwarded-For',
            'X-Forwarded'
        ]),

    function ($request, $response, $next) {
        //Get the user ip
        $ip = ClientIp::getIp($request);

        //Get all ips found in the headers
        $all_ips = ClientIp::getIps($request);

        return $next($request, $response);
    }
]);

Cors

To use the neomerx/cors-psr7 library:

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::Cors($settings)                 //(optional) instance of Neomerx\Cors\Contracts\Strategies\SettingsStrategyInterface
        ->origin('http://example.com:123')      //(optional) the server origin
        ->allowedOrigins([                      //(optional) Allowed origins
            'http://good.example.com:321' => true,
            'http://evil.example.com:123' => null,
        ])
        ->allowedMethods([                      //(optional) Allowed methods. The second argument forces to add the allowed methods to preflight response
            'GET' => true,
            'PATCH' => null,
            'POST' => true,
            'PUT' => null,
            'DELETE' => true,
        ], true)
        ->allowedHeaders([                      //(optional) Allowed headers. The second argument forces to add the allowed headers to preflight response
            'content-type' => true,
            'some-disabled-header' => null,
            'x-enabled-custom-header' => true,
        ], true)
        ->exposedHeaders([                      //(optional) Headers other than the simple ones that might be exposed to user agent
            'Content-Type' => true,
            'X-Custom-Header' => true,
            'X-Disabled-Header' => null,
        ])
        ->allowCredentials()                    //(optional) If access with credentials is supported by the resource.
        ->maxAge(0)                             //(optional) Set pre-flight cache max period in seconds.
        ->checkHost(true)                       //(optional) If request 'Host' header should be checked against server's origin.
]);

Csp

To use the paragonie/csp-builder library to add the Content-Security-Policy header to the response.

$dispatcher = $relay->getInstance([

    Middleware::csp($directives)                          //(optional) the array with the directives.
        ->addSource('img-src', 'https://ytimg.com')       //(optional) to add extra sources to whitelist
        ->addDirective('upgrade-insecure-requests', true) //(optional) to add new directives (if it doesn't already exist)
        ->supportOldBrowsers(false)                       //(optional) support old browsers (e.g. safari). True by default
]);

Csrf

To add a protection layer agains CSRF (Cross Site Request Forgety). The middleware injects a hidden input with a token in all POST forms and them check whether the token is valid or not.

$dispatcher = $relay->getInstance([

    //(optional) Used to open a PHP session before
    Middleware::phpSession(),

    //required to get the format of the request (only executed in html requests)
    Middleware::FormatNegotiator(),

    //required to get the user ip
    Middleware::ClientIp(),

    Middleware::Csrf($storage)  //(optional) array or ArrayAccess used to store the CSRF tokens. If it's not defined use $_SESSION.
]);

DebugBar

Inserts the PHP debug bar 2.x in the html body. This middleware requires Middleware::formatNegotiator executed before, to insert the debug bar only in Html responses.

Because this middleware serves also the debugbar assets (css, js and fonts), it must be added before the router to avoid 404 responses.

use Psr7Middlewares\Middleware;
use DebugBar\StandardDebugBar;

$debugBar = new StandardDebugBar();

$dispatcher = $relay->getInstance([

    Middleware::FormatNegotiator(),

    Middleware::DebugBar($debugBar) //(optional) Own instance of debugbar
        ->captureAjax(true)         //(optional) To send data in headers in ajax
]);

Delay

Delays the response to simulate slow bandwidth in local environments. You can use a number or an array to generate random values in seconds.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::delay(3.5),      //delay the response 3.5 seconds

    Middleware::delay([1, 2.5]), //delay the response between 1 and 1.5 seconds
]);

DetectDevice

Uses Mobile-Detect library to detect the client device.

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\DetectDevice;

$dispatcher = $relay->getInstance([

    Middleware::DetectDevice(),

    function ($request, $response, $next) {
        //Get the device info
        $device = DetectDevice::getDevice($request);

        if ($device->isMobile()) {
            //mobile stuff
        }
        elseif ($device->isTablet()) {
            //tablet stuff
        }
        elseif ($device->is('bot')) {
            //bot stuff
        }

        return $next($request, $response);
    },
]);

DigestAuthentication

Implements the digest http authentication. You have to provide an array with the users and password:

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::DigestAuthentication([
            'username1' => 'password1',
            'username2' => 'password2'
        ])
        ->realm('My realm') //(optional) custom realm value
        ->nonce(uniqid()),   //(optional) custom nonce value
        
    function ($request, $response, $next) {
        $username = DigestAuthentication::getUsername($request);

        return $next($request, $response);
    }
]);

EncodingNegotiator

Uses willdurand/Negotiation (2.x) to detect and negotiate the encoding type of the document.

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\EncodingNegotiator;

$dispatcher = $relay->getInstance([

    Middleware::EncodingNegotiator()
        ->encodings(['gzip', 'deflate']), //(optional) configure the supported encoding types

    function ($request, $response, $next) {
        //get the encoding (for example: gzip)
        $encoding = EncodingNegotiator::getEncoding($request);

        return $next($request, $response);
    }
]);

ErrorHandler

Executes a handler if the response returned by the next middlewares has any error (status code 400-599). You can catch also the exceptions throwed.

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\ErrorHandler;

function handler($request, $response, $myApp) {
    switch ($response->getStatusCode()) {
        case 404:
            return 'Page not found';

        case 500:
            //you can get the exception catched
            $exception = ErrorHandler::getException($request);

            return 'Server error: '.$exception->getMessage();

        default:
            return 'There was an error'
    }
}

$dispatcher = $relay->getInstance([

    Middleware::ErrorHandler('handler') //(optional) The error handler
        ->arguments($myApp)             //(optional) extra arguments to the handler
        ->catchExceptions()             //(optional) to catch exceptions
]);

FastRoute

To use FastRoute as a middleware.

use Psr7Middlewares\Middleware;

$router = FastRoute\simpleDispatcher(function (FastRoute\RouteCollector $r) {

    $r->addRoute('GET', '/blog/{id:[0-9]+}', function ($request, $response, $app) {
        return 'This is the post number'.$request->getAttribute('id');
    });
});

$dispatcher = $relay->getInstance([

    Middleware::FastRoute($router) //Instance of FastRoute\Dispatcher
        ->argument($myApp)         //(optional) arguments appended to the controller
]);

Firewall

Uses M6Web/Firewall to provide a IP filtering. This middleware deppends of ClientIp (to extract the ips from the headers).

See the ip formats allowed for trusted/untrusted options:

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    //required to capture the user ips before
    Middleware::ClientIp(),

    //set the firewall
    Middleware::Firewall()
        ->trusted(['123.0.0.*'])   //(optional) ips allowed
        ->untrusted(['123.0.0.1']) //(optional) ips not allowed
]);

FormatNegotiator

Uses willdurand/Negotiation (2.x) to detect and negotiate the format of the document using the url extension and/or the Accept http header. It also adds the Content-Type header to the response if it's missing.

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\FormatNegotiator;

$dispatcher = $relay->getInstance([

    Middleware::FormatNegotiator()
        ->defaultFormat('html') //(optional) default format if it's unable to detect. (by default is "html")
        ->addFormat('pdf', ['application/pdf', 'application/x-download']), //(optional) add new formats and mimetypes

    function ($request, $response, $next) {
        //get the format (for example: html)
        $format = FormatNegotiator::getFormat($request);

        return $next($request, $response);
    }
]);

FormTimestamp

Simple spam protection based on injecting a hidden input in all post forms with the current timestamp. On submit the form, check the time value. If it's less than (for example) 3 seconds ago, assumes it's a bot, so returns a 403 response. You can also set a max number of seconds before the form expires.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    //required to get the format of the request (only executed in html requests)
    Middleware::FormatNegotiator(),

    Middleware::FormTimestamp()
        ->key('my-secret-key'),   //Key used to encrypt/decrypt the input value.
        ->min(5)                  //(optional) Minimum seconds needed to validate the request (default: 3)
        ->max(3600)               //(optional) Life of the form in second. Default is 0 (no limit)
        ->inputName('time-token') //(optional) Name of the input (default: hpt_time)
]);

Geolocate

Uses Geocoder library to geolocate the client using the ip. This middleware deppends of ClientIp (to extract the ips from the headers).

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\Geolocate;

$dispatcher = $relay->getInstance([
    
    //required to capture the user ips before
    Middleware::ClientIp(),

    Middleware::Geolocate($geocoder), //(optional) To provide a custom Geocoder instance

    function ($request, $response, $next) {
        //get the location
        $addresses = Geolocate::getLocation($request);

        //get the country
        $country = $addresses->first()->getCountry();

        $response->getBody()->write('Hello to '.$country);

        return $next($request, $response);
    }
]);

GoogleAnalytics

Inject the Google Analytics code in all html pages.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([
    
    //required to get the format of the request
    Middleware::formatNegotiator(),
    
    Middleware::GoogleAnalytics('UA-XXXXX-X') //The site id
]);

Gzip

Use gzip functions to compress the response body, inserting also the Content-Encoding header.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    //required to get the preferred encoding type
    Middleware::EncodingNegotiator(),

    Middleware::Gzip()
]);

Honeypot

Implements a honeypot spam prevention. This technique is based on creating a input field that should be invisible and left empty by real users but filled by most spam bots. The middleware scans the html code and inserts this inputs in all post forms and check in the incoming requests whether this value exists and is empty (is a real user) or doesn't exist or has a value (is a bot) returning a 403 response.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([
    
    //required to get the format of the request (only executed in html requests)
    Middleware::formatNegotiator(),
    
    Middleware::Honeypot()
        ->inputName('my_name') //(optional) The name of the input field (by default "hpt_name")
        ->inputClass('hidden') //(optional) The class of the input field (by default "hpt_input")
]);

Https

Returns a redirection to the https scheme if the request uri is http. It also adds the Strict Transport Security header to protect against protocol downgrade attacks and cookie hijacking.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::Https()
        ->maxAge(1000000)     //(optional) max-age directive for the Strict-Transport-Security header. By default is 31536000 (1 year)
        ->includeSubdomains() //(optional) To add the "includeSubDomains" attribute to the Strict-Transport-Security header.
]);

ImageTransformer

Uses imagecow/imagecow 2.x to transform images on demand. You can resize, crop, rotate and convert to other formats. Use the the imagecow syntax to define the available sizes.

To define the available sizes, you have to asign a filename prefix representing the size, so any file requested with this prefix will be dinamically transformed.

There's also support for Client hints to avoid to serve images larger than needed (currently supported only in chrome and opera).

If you want to save the transformed images in the cache, provide a library compatible with psr-6 for that.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([
    
    //required to get the format of the request
    Middleware::formatNegotiator(),

    Middleware::imageTransformer([   // The available sizes of the images.
            'small.' => 'resizeCrop,50,50', //Creates a 50x50 thumb of any image prefixed with "small." (example: /images/small.avatar.jpg)
            'medium.' => 'resize,500|format,jpg', //Resize the image to 500px and convert to jpg
            'pictures/large.' => 'resize,1000|format,jpg', //Transform only images inside "pictures" directory (example: /images/pcitures/large.avatar.jpg)
        ])
        ->clientHints()              // (optional) To enable the client hints headers
        ->cache(new Psr6CachePool()) // (optional) To save the transformed images in the cache

    //Used to read the image files and returns the response with them
    Middleware::readResponse()
        ->storage('/path/to/images'),
]);

LanguageNegotiation

Uses willdurand/Negotiation to detect and negotiate the client language using the Accept-Language header and (optionally) the uri's path. You must provide an array with all available languages:

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\LanguageNegotiator;

$dispatcher = $relay->getInstance([

    Middleware::LanguageNegotiator(['gl', 'en']) //Available languages
        ->usePath(true)                          //(optional) To search the language in the path: /gl/, /en/
        ->redirect()                             //(optional) To return a redirection if the language is not in the path
        ->basePath('/web')                       //(optional) Basepath used to search the language

    function ($request, $response, $next) {
        //Get the preferred language
        $language = LanguageNegotiator::getLanguage($request);

        return $next($request, $response);
    }
]);

LeagueRoute

To use league/route (2.x) as a middleware:

use Psr7Middlewares\Middleware;
use League\Route\RouteCollection;

$router = new RouteCollection();

$router->get('/blog/{id:[0-9]+}', function ($request, $response, $vars) {
    return 'This is the post number'.$vars['id'];
});

$dispatcher = $relay->getInstance([

    Middleware::LeagueRoute($router) //The RouteCollection instance
]);

MethodOverride

Overrides the request method using the X-Http-Method-Override header. This is useful for clients unable to send other methods than GET and POST:

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::MethodOverride()
        ->get(['HEAD', 'CONNECT', 'TRACE', 'OPTIONS']), //(optional) to customize the allowed GET overrided methods
        ->post(['PATCH', 'PUT', 'DELETE', 'COPY', 'LOCK', 'UNLOCK']), //(optional) to customize the allowed POST overrided methods
]);

Minify

Uses mrclay/minify to minify the html, css and js code from the responses.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([
    
    //required to get the format of the response
    Middleware::formatNegotiator(),

    Middleware::Minify()
]);

Payload

Parses the body of the request if it's not parsed and the method is POST, PUT or DELETE. It has support for json, csv and url encoded format.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([
    
    Middleware::Payload(),

    function ($request, $response, $next) {
        //Get the parsed body
        $content = $request->getParsedBody();

        return $next($request, $response);
    }
]);

PhpSession

Initializes a php session using the request data.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([
    
    Middleware::PhpSession()
        ->name('SessionId') //(optional) Name of the session
        ->id('ABC123')      //(optional) Id of the session

    function ($request, $response, $next) {
        //Use the global $_SESSION variable to get/set data
        $_SESSION['name'] = 'John';

        return $next($request, $response);
    }
]);

Piwik

To use the Piwik analytics platform. Injects the javascript code just before the </body> closing tag.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([
    
    //required to get the format of the request
    Middleware::formatNegotiator(),
    
    Middleware::Piwik()
        ->piwikUrl('//example.com/piwik')    // The url of the installed piwik
        ->siteId(1)                          // (optional) The site id (1 by default)
        ->addOption('setDoNotTrack', 'true') // (optional) Add more options to piwik API
]);

ReadResponse

Read the response content from a file. It's the opposite of SaveResponse

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::ReadResponse('path/to/files') // Path where the files are stored
        ->appendQuery(true)                   // (optional) to use the uri query in the filename
        ->basePath('public')                  // (optional) basepath ignored from the request uri
]);

Recaptcha

To use the google recaptcha library for spam prevention.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([
    
    //required to get the user IP
    Middleware::ClientIp(),
    
    Middleware::Recapcha('secret') //The secret key
]);

Rename

Renames the request path. This is useful in some use cases:

To rename public paths with random suffixes for security reasons, for example the path /admin to a more unpredictible /admin-19640983
Create pretty urls without use any router. For example to access to the path /static-pages/about-me.php under the more friendly /about-me

Note that the original path wont be publicly accesible. On above examples, requests to /admin or /static-pages/about-me.php returns 404 responses.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::Rename([
        '/admin' => '/admin-19640983',
    ]),

    function ($request, $response, $next) {
        $path = $request->getUri()->getPath(); // /admin

        return $next($request, $response);
    }
]);

ResponseTime

Calculates the response time (in miliseconds) and saves it into X-Response-Time header:

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::ResponseTime()
]);

Robots

Disables the robots of the search engines for non-production environment. Adds automatically the header X-Robots-Tag: noindex, nofollow, noarchive in all responses and returns a default body for /robots.txt request.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::Robots(false) //(optional) Set true to allow search engines instead disallow
]);

SaveResponse

Saves the response content into a file if all of the following conditions are met:

The method is GET
The status code is 200
The Cache-Control header does not contain no-cache value
The request has not query parameters.

This is useful for cache purposes

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::SaveResponse('path/to/files') //Path directory where save the responses
        ->appendQuery(true)                   // (optional) to append the uri query to the filename
        ->basePath('public')                  //(optional) basepath ignored from the request uri
]);

Shutdown

Useful to display a 503 maintenance page. You need to specify a handler.

use Psr7Middlewares\Middleware;

function shutdownHandler ($request, $response, $app) {
    $response->getBody()->write('Service unavailable');
}

$dispatcher = $relay->getInstance([

    Middleware::Shutdown('shutdownHandler') //(optional) Callable that generate the response
        ->arguments($app)                   //(optional) to add extra arguments to the handler
]);

TrailingSlash

Removes (or adds) the trailing slash of the path. For example, /post/23/ will be converted to /post/23. If the path is / it won't be converted. Useful if you have problems with the router.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::TrailingSlash(true) //(optional) set true to add the trailing slash instead remove
        ->redirect(301)             //(optional) to return a 301 (seo friendly) or 302 response to the new path
        ->basePath('public')        //(optional) basepath
]);

Uuid

Uses ramsey/uuid (3.x) to generate an Uuid (Universally Unique Identifiers) for each request (compatible with RFC 4122 versions 1, 3, 4 and 5). It's usefull for debugging purposes.

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\Uuid;

$dispatcher = $relay->getInstance([

    Middleware::Uuid()
        ->version(4)     //(optional) version of the identifier (1 by default). Versions 3 and 5 need more arguments (see https://github.com/ramsey/uuid#examples)
        ->header(false), //(optional) Name of the header to store the identifier (X-Uuid by default). Set false to don't save header

    function ($request, $response, $next) {
        //Get the X-Uuid header
        $id = $request->getHeaderLine('X-Uuid');

        //Get the Uuid instance
        $uuid = Uuid::getUuid($request);

        echo $uuid->toString();

        return $next($request, $response);
    }
]);

Whoops

To use whoops 2.x as error handler.

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Middleware\Whoops;
use Whoops\Run;

$whoops = new Run();

$dispatcher = $relay->getInstance([

    //(optional) this allows whoops to choose the best handler according with the expected format
    Middleware::formatNegotiator(),

    Middleware::Whoops($whoops) //(optional) provide a custom whoops instance
        ->catchErrors(false)    //(optional) to catch not only exceptions but also php errors (true by default)
]);

Www

Adds or removes the www subdomain in the host uri and, optionally, returns a redirect response. The following types of host values wont be changed:

The one word hosts, for example: http://localhost.
The ip based hosts, for example: http://0.0.0.0.
The multi domain hosts, for example: http://subdomain.example.com.

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    Middleware::Www(true) //(optional) Add www instead remove it
        ->redirect(301)   //(optional) to return a 301 (seo friendly), 302 response to the new host or false to don't redirect. (301 by default)
]);

Lazy/conditional middleware creation

You may want to create middleware in a lazy way under some circunstances:

The middleware is needed only in a specific context (for example in development environments)
The middleware creation is expensive and is not needed always (because a previous middleware returns a cached response)

To handle with this, you can use the Middleware::create() method that must return a callable or false. Example:

use Psr7Middlewares\Middleware;

$dispatcher = $relay->getInstance([

    //This middleware can return a cached response
    //so the next middleware may not be executed
    Middleware::cache($myPsr6CachePool),

    //Let's say this middleware is expensive, so use a proxy for lazy creation
    Middleware::create(function () use ($app) {
        return Middleware::auraRouter($app->get('router'));
    }),

    //This middleware is needed only in production
    Middleware::create(function () {
        return (getenv('ENV') !== 'production') ? false : Middleware::minify();
    }),

    //This middleware is needed in some cases
    Middleware::create(function ($request, $response) {
        if ($request->hasHeader('Foo')) {
            return Middleware::www();
        }

        return false;
    })
]);

Extending middlewares

Some middlewares use different functions to change the http messages, depending of some circunstances. For example, Payload parses the raw body content, and the method used depends of the type of the content: it can be json, urlencoded, csv, etc. Other example is the Minify middleware that needs a different minifier for each format (html, css, js, etc), or the Gzip that depending of the Accept-Encoding header, use a different method to compress the response body.

The interface Psr7Middlewares\Transformers\ResolverInterface provides a way to resolve and returns the apropiate "transformer" in each case. The transformer is just a callable that accepts a http message (request or response) and returns the transformed message again. You can create custom resolvers or extend the included in this package to add your owns. Let's see an example:

use Psr7Middlewares\Transformers\BodyParser;
use Psr\Http\Message\ServerRequestInterface;

class MyBodyParser extends BodyParser
{
    /**
     * New parser used in request with the format "php"
     */
    public function php(ServerRequestInterface $request)
    {
        $data = unserialize((string) $request->getBody());

        return $request->withParsedBody($data);
    }
}

//Use the resolver
$dispatcher = $relay->getInstance([
    Middleware::Payload()->resolver(new MyBodyParser())
]);

The following middlewares are using resolvers that you can customize:

Payload To parse the body according with the format (json, urlencoded, csv, ...)
Gzip To encode the body with the encoding method supported by the browser (gzip, deflate)
Minify To use different minifiers for each format (html, css, js, ...)

Contribution

New middlewares are appreciated. Just create a pull request.

localheinz / psr7-middlewares Goto Github PK