Psr7Middlewares\Middleware\FormatNegotiator

Complexity

Total Complexity

14

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Importance

Changes	4
Bugs	2	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getFormat()	0	4	1
A	addFormat()	0	6	1
A	defaultFormat()	0	6	1
B	__invoke()	0	16	5
A	getFromExtension()	0	6	2
A	getFromHeader()	0	12	4

<?php

namespace Psr7Middlewares\Middleware;

use Psr7Middlewares\Middleware;
use Psr7Middlewares\Utils;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;
use Negotiation\Negotiator;

/**
 * Middleware returns the client preferred format.
 */
class FormatNegotiator
{
    use Utils\NegotiateTrait;

    const KEY = 'FORMAT';

    /**
     * @var string Default format
     */
    private $default = 'html';

    /**
     * @var array Available formats with the mime types
     */
    private $formats = [
        'html' => ['text/html', 'application/xhtml+xml'],
        'css' => ['text/css'],
        'gif' => ['image/gif'],
        'png' => ['image/png', 'image/x-png'],
        'jpg' => ['image/jpeg', 'image/jpg'],
        'jpeg' => ['image/jpeg', 'image/jpg'],
        'json' => ['application/json', 'text/json', 'application/x-json'],
        'jsonp' => ['text/javascript', 'application/javascript', 'application/x-javascript'],
        'js' => ['text/javascript', 'application/javascript', 'application/x-javascript'],
        'pdf' => ['application/pdf', 'application/x-download'],
        'rdf' => ['application/rdf+xml'],
        'rss' => ['application/rss+xml'],
        'atom' => ['application/atom+xml'],
        'xml' => ['text/xml', 'application/xml', 'application/x-xml'],
        'txt' => ['text/plain'],
        'mp4' => ['video/mp4'],
        'otf' => ['font/opentype'],
        'ttf' => ['font/ttf', 'application/font-ttf', 'application/x-font-ttf'],
        'ogg' => ['audio/ogg'],
        'ogv' => ['video/ogg'],
        'webm' => ['video/webm'],
        'woff' => ['font/woff', 'application/font-woff', 'application/x-font-woff'],
        'webp' => ['image/webp'],
        'svg' => ['image/svg+xml'],
        'zip' => ['application/zip', 'application/x-zip', 'application/x-zip-compressed'],
    ];

    /**
     * Returns the format.
     *
     * @param ServerRequestInterface $request
     *
     * @return string|null
     */
    public static function getFormat(ServerRequestInterface $request)
    {
        return Middleware::getAttribute($request, self::KEY);
    }

    /**
     * Add a new format.
     *
     * @param string $format
     * @param array  $mimeTypes
     *
     * @return self
     */
    public function addFormat($format, array $mimeTypes)
    {
        $this->formats[$format] = $mimeTypes;

        return $this;
    }

    /**
     * Set the default format.
     *
     * @param string $format
     *
     * @return self
     */
    public function defaultFormat($format)
    {
        $this->default = $format;

        return $this;
    }

    /**
     * Execute the middleware.
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface      $response
     * @param callable               $next
     *
     * @return ResponseInterface
     */
    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
    {
        $format = $this->getFromExtension($request) ?: $this->getFromHeader($request) ?: $this->default;

        if ($format) {
            $request = Middleware::setAttribute($request, self::KEY, $format);
        }

        $response = $next($request, $response);

        if ($format) {
            $response = $response->withHeader('Content-Type', $this->formats[$format][0].'; charset=utf-8');
        }

        return $response;
    }

    /**
     * Returns the format using the file extension.
     *
     * @return null|string
     */
    private function getFromExtension(ServerRequestInterface $request)
    {
        $format = strtolower(pathinfo($request->getUri()->getPath(), PATHINFO_EXTENSION));

        return isset($this->formats[$format]) ? $format : null;
    }

    /**
     * Returns the format using the Accept header.
     *
     * @return null|string
     */
    private function getFromHeader(ServerRequestInterface $request)
    {
        $format = $this->negotiateHeader($request->getHeaderLine('Accept'), new Negotiator(), call_user_func_array('array_merge', array_values($this->formats)));

        if ($format !== null) {
            foreach ($this->formats as $extension => $headers) {
                if (in_array($format, $headers)) {
                    return $extension;
                }
            }
        }
    }
}