RichanFongdasen\Varnishable\Concerns\ManipulateHttpResponse

Complexity

Total Complexity

12

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	acknowledgeEsiSupport()	0	8	2
A	addCacheableHeader()	0	7	1
A	addUncacheableHeader()	0	4	1
A	addEtagHeader()	0	6	2
A	getCacheDuration()	0	6	2
A	manipulate()	0	13	2
A	setRequestHeaders()	0	4	1
A	shouldNotCache()	0	4	1
	getConfig()	0	1	?

<?php

namespace RichanFongdasen\Varnishable\Concerns;

use Illuminate\Http\Response;
use Symfony\Component\HttpFoundation\HeaderBag;

trait ManipulateHttpResponse
{
    /**
     * HTTP Request object.
     *
     * @var \Symfony\Component\HttpFoundation\HeaderBag
     */
    protected $requestHeaders;

    /**
     * Acknowledge the ESI support and send a specific
     * HTTP header as a reply.
     *
     * @param \Illuminate\Http\Response $response
     *
     * @return void
     */
    protected function acknowledgeEsiSupport(Response $response)
    {
        $esiHeader = $this->getConfig('esi_capability_header');

        if ($esiHeader = $this->requestHeaders->get($esiHeader)) {
            $response->header($this->getConfig('esi_reply_header'), $esiHeader);
        }
    }

    /**
     * Add cacheable header so varnish can recognize
     * the response as a cacheable content.
     *
     * @param \Illuminate\Http\Response $response
     * @param int                       $cacheDuration
     */
    protected function addCacheableHeader(Response $response, $cacheDuration)
    {
        $duration = $this->getCacheDuration((int) $cacheDuration);

        return $response->header($this->getConfig('cacheable_header'), '1')
                ->header('Cache-Control', 'public, max-age='.$duration);
    }

    /**
     * Add uncacheable header so varnish can recognize
     * the response as an uncacheable content.
     *
     * @param \Illuminate\Http\Response $response
     */
    public function addUncacheableHeader(Response $response)
    {
        return $response->header($this->getConfig('uncacheable_header'), '1');
    }

    /**
     * Add an ETag header to the current response.
     *
     * @param \Illuminate\Http\Response $response
     *
     * @return void
     */
    protected function addEtagHeader(Response $response)
    {
        if ($this->getConfig('use_etag')) {
            $response->setEtag(md5($response->getContent()));
        }
    }

    /**
     * Normalize the given cache duration and convert
     * it to seconds.
     *
     * @param int $duration
     *
     * @return int|float
     */
    protected function getCacheDuration($duration)
    {
        $cacheInMinutes = ($duration > 0) ? $duration : $this->getConfig('cache_duration');

        return $cacheInMinutes * 60;
    }

    /**
     * Manipulate the current Http response.
     *
     * @param \Illuminate\Http\Response $response
     * @param int                       $cacheDuration
     *
     * @return \Illuminate\Http\Response
     */
    public function manipulate(Response $response, $cacheDuration)
    {
        $this->acknowledgeEsiSupport($response);

        if ($this->shouldNotCache($response)) {
            return $response;
        }

        $this->addCacheableHeader($response, $cacheDuration);
        $this->addEtagHeader($response);

        return $response;
    }

    /**
     * Set the current Http request headers.
     *
     * @param \Symfony\Component\HttpFoundation\HeaderBag $headers
     */
    public function setRequestHeaders(HeaderBag $headers)
    {
        $this->requestHeaders = $headers;
    }

    /**
     * Check if the current response shouldn't be cached.
     *
     * @param \Illuminate\Http\Response $response
     *
     * @return string|array
     */
    protected function shouldNotCache(Response $response)
    {
        return $response->headers->get($this->getConfig('uncacheable_header'));
    }

    /**
     * Get configuration value for a specific key.
     *
     * @param string $key
     *
     * @return mixed
     */
    abstract public function getConfig($key);
}