RichanFongdasen\Varnishable\Concerns\InvalidateVarnishCache

Complexity

Total Complexity

10

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	flush()	0	6	1
A	banByPattern()	0	7	1
A	banByPatterns()	0	6	2
A	banByUrl()	0	7	1
A	banByUrls()	0	6	2
A	getVarnishUrl()	0	4	1
A	sendBanRequest()	0	10	2
	getConfig()	0	1	?
	getGuzzle()	0	1	?

<?php

namespace RichanFongdasen\Varnishable\Concerns;

use Exception;
use GuzzleHttp\Client;

trait InvalidateVarnishCache
{
    /**
     * Flush entire cache for an application hostname.
     *
     * @param string $hostname
     *
     * @throws Exception
     *
     * @return void
     */
    public function flush(string $hostname): void
    {
        $this->sendBanRequest([
            'X-Ban-Host' => $hostname,
        ], 'FULLBAN');
    }

    /**
     * Generate ban request for an application hostname,
     * specified by a regular expression.
     *
     * @param string $hostname
     * @param string $pattern
     *
     * @throws Exception
     *
     * @return void
     */
    public function banByPattern(string $hostname, string $pattern): void
    {
        $this->sendBanRequest([
            'X-Ban-Host'  => $hostname,
            'X-Ban-Regex' => $pattern,
        ]);
    }

    /**
     * Generate ban request for an application hostname,
     * specified by a set of regular expression.
     *
     * @param string $hostname
     * @param array  $patterns
     *
     * @throws Exception
     *
     * @return void
     */
    public function banByPatterns(string $hostname, array $patterns): void
    {
        foreach ($patterns as $pattern) {
            $this->banByPattern($hostname, $pattern);
        }
    }

    /**
     * Generate ban request for an application hostname,
     * specified by a single urls.
     *
     * @param string $hostname
     * @param string $url
     *
     * @throws Exception
     *
     * @return void
     */
    public function banByUrl(string $hostname, string $url): void
    {
        $this->sendBanRequest([
            'X-Ban-Host' => $hostname,
            'X-Ban-Url'  => $url,
        ]);
    }

    /**
     * Generate ban request for an application hostname,
     * specified by a set of urls.
     *
     * @param string $hostname
     * @param array  $urls
     *
     * @throws Exception
     *
     * @return void
     */
    public function banByUrls(string $hostname, array $urls): void
    {
        foreach ($urls as $url) {
            $this->banByUrl($hostname, $url);
        }
    }

    /**
     * Get a valid varnish host url to send the
     * ban request.
     *
     * @param string $varnishHost
     *
     * @return string
     */
    protected function getVarnishUrl(string $varnishHost): string
    {
        return 'http://'.$varnishHost.':'.$this->getConfig('varnish_port').'/';
    }

    /**
     * Send the ban request to every varnish hosts.
     *
     * @param array  $headers
     * @param string $method
     *
     * @throws Exception
     *
     * @return void
     */
    protected function sendBanRequest(array $headers, string $method = 'BAN'): void
    {
        $guzzle = $this->getGuzzle();

        foreach ((array) $this->getConfig('varnish_hosts') as $varnishHost) {
            $url = $this->getVarnishUrl($varnishHost);

            $guzzle->request($method, $url, ['headers' => $headers]);
        }
    }

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

    /**
     * Get guzzle client object.
     *
     * @return \GuzzleHttp\Client
     */
    abstract public function getGuzzle(): Client;
}