Varnish::getHeaderLength() - Code Metrics - Inspection of "feat(client): adds a noop client which implements..." - FriendsOfSymfony/FOSHttpCache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#289)

by Gavin

created 2016-06-29 15:00 UTC

Varnish::getHeaderLength() A

↳ Parent: Varnish

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

/*
 * This file is part of the FOSHttpCache package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCache\ProxyClient;

use FOS\HttpCache\Exception\InvalidArgumentException;
use FOS\HttpCache\Exception\MissingHostException;
use FOS\HttpCache\ProxyClient\Invalidation\BanInterface;
use FOS\HttpCache\ProxyClient\Invalidation\PurgeInterface;
use FOS\HttpCache\ProxyClient\Invalidation\RefreshInterface;
use FOS\HttpCache\ProxyClient\Invalidation\TagsInterface;
use Http\Message\MessageFactory;

/**
 * Varnish HTTP cache invalidator.
 *
 * Additional constructor options:
 * - tags_header   Header for tagging responses, defaults to X-Cache-Tags
 * - header_length Maximum header length, defaults to 7500 bytes
 *
 * @author David de Boer <[email protected]>
 */
class Varnish extends AbstractProxyClient implements BanInterface, PurgeInterface, RefreshInterface, TagsInterface
{
    const HTTP_METHOD_BAN          = 'BAN';
    const HTTP_METHOD_PURGE        = 'PURGE';
    const HTTP_METHOD_REFRESH      = 'GET';
    const HTTP_HEADER_HOST         = 'X-Host';
    const HTTP_HEADER_URL          = 'X-Url';
    const HTTP_HEADER_CONTENT_TYPE = 'X-Content-Type';

    /**
     * Map of default headers for ban requests with their default values.
     *
     * @var array
     */
    private $defaultBanHeaders = [
        self::HTTP_HEADER_HOST         => self::REGEX_MATCH_ALL,
        self::HTTP_HEADER_URL          => self::REGEX_MATCH_ALL,
        self::HTTP_HEADER_CONTENT_TYPE => self::REGEX_MATCH_ALL
    ];

    /**
     * Set the default headers that get merged with the provided headers in self::ban().
     *
     * @param array $headers Hashmap with keys being the header names, values
     *                       the header values.
     */
    public function setDefaultBanHeaders(array $headers)
    {
        $this->defaultBanHeaders = $headers;
    }

    /**
     * Add or overwrite a default ban header.
     *
     * @param string $name  The name of that header
     * @param string $value The content of that header
     */
    public function setDefaultBanHeader($name, $value)
    {
        $this->defaultBanHeaders[$name] = $value;
    }

    /**
     * {@inheritdoc}
     */
    public function invalidateTags(array $tags)
    {
        $escapedTags = array_map('preg_quote', $this->escapeTags($tags));

        if (mb_strlen(implode('|', $escapedTags)) >= $this->options['header_length']) {
            /*
             * estimate the amount of tags to invalidate by dividing the max
             * header length by the largest tag (minus 1 for the implode character)
             */
            $tagsize = max(array_map('mb_strlen', $escapedTags));
            $elems = floor($this->options['header_length'] / ($tagsize - 1)) ? : 1;
        } else {
            $elems = count($escapedTags);
        }

        foreach (array_chunk($escapedTags, $elems) as $tagchunk) {
            $tagExpression = sprintf('(%s)(,.+)?$', implode('|', $tagchunk));
            $this->ban([$this->options['tags_header'] => $tagExpression]);
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getTagsHeaderValue(array $tags)
    {
        return array_unique($this->escapeTags($tags));
    }

    /**
     * Get the HTTP header name that will hold cache tags.
     *
     * @return string
     */
    public function getTagsHeaderName()
    {
        return $this->options['tags_header'];
    }

    /**
     * Get the maximum HTTP header length.
     *
     * @return int
     */
    public function getHeaderLength()
    {
        return $this->options['header_length'];
    }

    /**
     * {@inheritdoc}
     */
    public function ban(array $headers)
    {
        $headers = array_merge(
            $this->defaultBanHeaders,
            $headers
        );

        $this->queueRequest(self::HTTP_METHOD_BAN, '/', $headers);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function banPath($path, $contentType = null, $hosts = null)
    {
        if (is_array($hosts)) {
            if (!count($hosts)) {
                throw new InvalidArgumentException('Either supply a list of hosts or null, but not an empty array.');
            }
            $hosts = '^('.join('|', $hosts).')$';
        }

        $headers = [
            self::HTTP_HEADER_URL => $path,
        ];

        if ($contentType) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $headers[self::HTTP_HEADER_CONTENT_TYPE] = $contentType;
        }
        if ($hosts) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $headers[self::HTTP_HEADER_HOST] = $hosts;
        }

        return $this->ban($headers);
    }

    /**
     * {@inheritdoc}
     */
    public function purge($url, array $headers = [])
    {
        $this->queueRequest(self::HTTP_METHOD_PURGE, $url, $headers);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function refresh($url, array $headers = [])

    {
        $headers = array_merge($headers, ['Cache-Control' => 'no-cache']);
        $this->queueRequest(self::HTTP_METHOD_REFRESH, $url, $headers);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultOptions()
    {
        $resolver = parent::getDefaultOptions();
        $resolver->setDefaults(['tags_header' => 'X-Cache-Tags']);
        $resolver->setDefaults(['header_length' => 7500]);

        return $resolver;
    }

    /**
     * Build the invalidation request and validate it.
     *
     * {@inheritdoc}
     *
     * @throws MissingHostException If a relative path is queued for purge/
     *                              refresh and no base URL is set
     *
     */
    protected function queueRequest($method, $url, array $headers = [])
    {
        $request = $this->messageFactory->createRequest($method, $url, $headers);

        if (self::HTTP_METHOD_BAN !== $method
            && null === $this->options['base_uri']
            && !$request->getHeaderLine('Host')
        ) {
            throw MissingHostException::missingHost($url);
        }

        $this->httpAdapter->invalidate($request);
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSHttpCache package.
5		*
6		* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace FOS\HttpCache\ProxyClient;
13
14		use FOS\HttpCache\Exception\InvalidArgumentException;
15		use FOS\HttpCache\Exception\MissingHostException;
16		use FOS\HttpCache\ProxyClient\Invalidation\BanInterface;
17		use FOS\HttpCache\ProxyClient\Invalidation\PurgeInterface;
18		use FOS\HttpCache\ProxyClient\Invalidation\RefreshInterface;
19		use FOS\HttpCache\ProxyClient\Invalidation\TagsInterface;
20		use Http\Message\MessageFactory;
21
22		/**
23		* Varnish HTTP cache invalidator.
24		*
25		* Additional constructor options:
26		* - tags_header Header for tagging responses, defaults to X-Cache-Tags
27		* - header_length Maximum header length, defaults to 7500 bytes
28		*
29		* @author David de Boer <[email protected]>
30		*/
31		class Varnish extends AbstractProxyClient implements BanInterface, PurgeInterface, RefreshInterface, TagsInterface
32		{
33		const HTTP_METHOD_BAN = 'BAN';
34		const HTTP_METHOD_PURGE = 'PURGE';
35		const HTTP_METHOD_REFRESH = 'GET';
36		const HTTP_HEADER_HOST = 'X-Host';
37		const HTTP_HEADER_URL = 'X-Url';
38		const HTTP_HEADER_CONTENT_TYPE = 'X-Content-Type';
39
40		/**
41		* Map of default headers for ban requests with their default values.
42		*
43		* @var array
44		*/
45		private $defaultBanHeaders = [
46		self::HTTP_HEADER_HOST => self::REGEX_MATCH_ALL,
47		self::HTTP_HEADER_URL => self::REGEX_MATCH_ALL,
48		self::HTTP_HEADER_CONTENT_TYPE => self::REGEX_MATCH_ALL
49		];
50
51		/**
52		* Set the default headers that get merged with the provided headers in self::ban().
53		*
54		* @param array $headers Hashmap with keys being the header names, values
55		* the header values.
56		*/
57		public function setDefaultBanHeaders(array $headers)
58		{
59		$this->defaultBanHeaders = $headers;
60		}
61
62		/**
63		* Add or overwrite a default ban header.
64		*
65		* @param string $name The name of that header
66		* @param string $value The content of that header
67		*/
68		public function setDefaultBanHeader($name, $value)
69		{
70		$this->defaultBanHeaders[$name] = $value;
71		}
72
73		/**
74		* {@inheritdoc}
75		*/
76		public function invalidateTags(array $tags)
77		{
78		$escapedTags = array_map('preg_quote', $this->escapeTags($tags));
79
80		if (mb_strlen(implode('\|', $escapedTags)) >= $this->options['header_length']) {
81		/*
82		* estimate the amount of tags to invalidate by dividing the max
83		* header length by the largest tag (minus 1 for the implode character)
84		*/
85		$tagsize = max(array_map('mb_strlen', $escapedTags));
86		$elems = floor($this->options['header_length'] / ($tagsize - 1)) ? : 1;
87		} else {
88		$elems = count($escapedTags);
89		}
90
91		foreach (array_chunk($escapedTags, $elems) as $tagchunk) {
92		$tagExpression = sprintf('(%s)(,.+)?$', implode('\|', $tagchunk));
93		$this->ban([$this->options['tags_header'] => $tagExpression]);
94		}
95
96		return $this;
97		}
98
99		/**
100		* {@inheritdoc}
101		*/
102		public function getTagsHeaderValue(array $tags)
103		{
104		return array_unique($this->escapeTags($tags));
105		}
106
107		/**
108		* Get the HTTP header name that will hold cache tags.
109		*
110		* @return string
111		*/
112		public function getTagsHeaderName()
113		{
114		return $this->options['tags_header'];
115		}
116
117		/**
118		* Get the maximum HTTP header length.
119		*
120		* @return int
121		*/
122		public function getHeaderLength()
123		{
124		return $this->options['header_length'];
125		}
126
127		/**
128		* {@inheritdoc}
129		*/
130		public function ban(array $headers)
131		{
132		$headers = array_merge(
133		$this->defaultBanHeaders,
134		$headers
135		);
136
137		$this->queueRequest(self::HTTP_METHOD_BAN, '/', $headers);
138
139		return $this;
140		}
141
142		/**
143		* {@inheritdoc}
144		*/
145		public function banPath($path, $contentType = null, $hosts = null)
146		{
147		if (is_array($hosts)) {
148		if (!count($hosts)) {
149		throw new InvalidArgumentException('Either supply a list of hosts or null, but not an empty array.');
150		}
151		$hosts = '^('.join('\|', $hosts).')$';
152		}
153
154		$headers = [
155		self::HTTP_HEADER_URL => $path,
156		];
157
158		if ($contentType) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-23 22:08 UTC by Report Bug Copy Issue Report The expression `$contentType` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
159		$headers[self::HTTP_HEADER_CONTENT_TYPE] = $contentType;
160		}
161		if ($hosts) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-23 22:08 UTC by Report Bug Copy Issue Report The expression `$hosts` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
162		$headers[self::HTTP_HEADER_HOST] = $hosts;
163		}
164
165		return $this->ban($headers);
166		}
167
168		/**
169		* {@inheritdoc}
170		*/
171		public function purge($url, array $headers = [])
172		{
173		$this->queueRequest(self::HTTP_METHOD_PURGE, $url, $headers);
174
175		return $this;
176		}
177
178		/**
179		* {@inheritdoc}
180		*/
181	View Code Duplication	public function refresh($url, array $headers = [])
		0 ignored issues – show Duplication introduced 2015-11-23 22:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
182		{
183		$headers = array_merge($headers, ['Cache-Control' => 'no-cache']);
184		$this->queueRequest(self::HTTP_METHOD_REFRESH, $url, $headers);
185
186		return $this;
187		}
188
189		/**
190		* {@inheritdoc}
191		*/
192		protected function getDefaultOptions()
193		{
194		$resolver = parent::getDefaultOptions();
195		$resolver->setDefaults(['tags_header' => 'X-Cache-Tags']);
196		$resolver->setDefaults(['header_length' => 7500]);
197
198		return $resolver;
199		}
200
201		/**
202		* Build the invalidation request and validate it.
203		*
204		* {@inheritdoc}
205		*
206		* @throws MissingHostException If a relative path is queued for purge/
207		* refresh and no base URL is set
208		*
209		*/
210		protected function queueRequest($method, $url, array $headers = [])
211		{
212		$request = $this->messageFactory->createRequest($method, $url, $headers);
213
214		if (self::HTTP_METHOD_BAN !== $method
215		&& null === $this->options['base_uri']
216		&& !$request->getHeaderLine('Host')
217		) {
218		throw MissingHostException::missingHost($url);
219		}
220
221		$this->httpAdapter->invalidate($request);
222		}
223		}
224

FriendsOfSymfony / FOSHttpCache

Pull Request — master (#289)

Varnish::getHeaderLength() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like