Varnish::ban() - Code Metrics - Inspection of "Add support for Varnish xkey" - FriendsOfSymfony/FOSHttpCache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#332)

by André

created 2017-10-31 18:30 UTC

Varnish::ban() A

↳ Parent: Varnish

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	1
crap	1

<?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\ProxyClient\Invalidation\BanCapable;
use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
use FOS\HttpCache\ProxyClient\Invalidation\RefreshCapable;
use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;

/**
 * Varnish HTTP cache invalidator.
 *
 * Additional constructor options:
 * - tags_header         Header for sending tag invalidation requests to
 *                       Varnish, defaults to X-Cache-Tags
 * - header_length       Maximum header length when invalidating tags. If there
 *                       are more tags to invalidate than fit into the header,
 *                       the invalidation request is split into several requests.
 *                       Defaults to 7500
 * - default_ban_headers Map of header name => header value that have to be set
 *                       on each ban request, merged with the built-in headers
 *
 * @author David de Boer <[email protected]>
 */
class Varnish extends HttpProxyClient implements BanCapable, PurgeCapable, RefreshCapable, TagCapable
{
    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';

    /**
     * Default name of the header used to invalidate content with specific tags.
     *
     * This happens to be the same as TagHeaderFormatter::DEFAULT_HEADER_NAME
     * but does not technically need to be the same.
     *
     * @var string
     */
    const DEFAULT_HTTP_HEADER_CACHE_TAGS = 'X-Cache-Tags';

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

        if ($tagMode === 'purge_single') {
            $elems = 1;
        } elseif (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) {
            if ($tagMode === 'ban') {
                $tagExpression = sprintf('(%s)(,.+)?$', implode('|', $tagchunk));
                $this->ban([$this->options['tags_header'] => $tagExpression]);
            } else {
                $this->queueRequest(
                    self::HTTP_METHOD_PURGE,
                    '/',
                    [$this->options['tags_header'] => implode(' ', $tagchunk)],
                    false
                );
            }
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function ban(array $headers)
    {
        $headers = array_merge(
            $this->options['default_ban_headers'],
            $headers
        );

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

        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 = '^('.implode('|', $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 configureOptions()
    {
        $resolver = parent::configureOptions();
        $resolver->setDefaults([
            'tags_header' => self::DEFAULT_HTTP_HEADER_CACHE_TAGS,
            'tag_mode' => 'ban',
            'header_length' => 7500,
            'default_ban_headers' => [],
        ]);
        // tag_mode options: 'ban', 'purge', or 'purge_single' for purge invalidation per tag
        $resolver->setAllowedValues('tag_mode', ['ban', 'purge', 'purge_single']);
        $resolver->setNormalizer('default_ban_headers', function ($resolver, $specified) {
            return array_merge(
                [
                    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,
                ],
                $specified
            );
        });

        return $resolver;
    }
}


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\ProxyClient\Invalidation\BanCapable;
16			use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
17			use FOS\HttpCache\ProxyClient\Invalidation\RefreshCapable;
18			use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;
19
20			/**
21			* Varnish HTTP cache invalidator.
22			*
23			* Additional constructor options:
24			* - tags_header Header for sending tag invalidation requests to
25			* Varnish, defaults to X-Cache-Tags
26			* - header_length Maximum header length when invalidating tags. If there
27			* are more tags to invalidate than fit into the header,
28			* the invalidation request is split into several requests.
29			* Defaults to 7500
30			* - default_ban_headers Map of header name => header value that have to be set
31			* on each ban request, merged with the built-in headers
32			*
33			* @author David de Boer <[email protected]>
34			*/
35			class Varnish extends HttpProxyClient implements BanCapable, PurgeCapable, RefreshCapable, TagCapable
36			{
37			const HTTP_METHOD_BAN = 'BAN';
38			const HTTP_METHOD_PURGE = 'PURGE';
39			const HTTP_METHOD_REFRESH = 'GET';
40			const HTTP_HEADER_HOST = 'X-Host';
41			const HTTP_HEADER_URL = 'X-Url';
42			const HTTP_HEADER_CONTENT_TYPE = 'X-Content-Type';
43
44			/**
45			* Default name of the header used to invalidate content with specific tags.
46			*
47			* This happens to be the same as TagHeaderFormatter::DEFAULT_HEADER_NAME
48			* but does not technically need to be the same.
49			*
50			* @var string
51			*/
52			const DEFAULT_HTTP_HEADER_CACHE_TAGS = 'X-Cache-Tags';
53
54			/**
55			* {@inheritdoc}
56			*/
57	4		public function invalidateTags(array $tags)
58			{
59	4		$tagMode = $this->options['tag_mode'];
60	4		$escapedTags = array_map('preg_quote', $this->escapeTags($tags));
61
62	4		if ($tagMode === 'purge_single') {
63			$elems = 1;
64	4		} elseif (mb_strlen(implode('\|', $escapedTags)) >= $this->options['header_length']) {
65			/*
66			* estimate the amount of tags to invalidate by dividing the max
67			* header length by the largest tag (minus 1 for the implode character)
68			*/
69	1		$tagsize = max(array_map('mb_strlen', $escapedTags));
70	1		$elems = floor($this->options['header_length'] / ($tagsize - 1)) ?: 1;
71	1		} else {
72	3		$elems = count($escapedTags);
73			}
74
75	4		foreach (array_chunk($escapedTags, $elems) as $tagchunk) {
76	4		if ($tagMode === 'ban') {
77	4		$tagExpression = sprintf('(%s)(,.+)?$', implode('\|', $tagchunk));
78	4		$this->ban([$this->options['tags_header'] => $tagExpression]);
79	4		} else {
80			$this->queueRequest(
81			self::HTTP_METHOD_PURGE,
82			'/',
83			[$this->options['tags_header'] => implode(' ', $tagchunk)],
84			false
85			);
86			}
87	4		}
88
89	4		return $this;
90			}
91
92			/**
93			* {@inheritdoc}
94			*/
95	10		public function ban(array $headers)
96			{
97	10		$headers = array_merge(
98	10		$this->options['default_ban_headers'],
99			$headers
100	10		);
101
102	10		$this->queueRequest(self::HTTP_METHOD_BAN, '/', $headers, false);
103
104	10		return $this;
105			}
106
107			/**
108			* {@inheritdoc}
109			*/
110	4		public function banPath($path, $contentType = null, $hosts = null)
111			{
112	4		if (is_array($hosts)) {
113	2		if (!count($hosts)) {
114	1		throw new InvalidArgumentException('Either supply a list of hosts or null, but not an empty array.');
115			}
116	1		$hosts = '^('.implode('\|', $hosts).')$';
117	1		}
118
119			$headers = [
120	3		self::HTTP_HEADER_URL => $path,
121	3		];
122
123	3		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...
124	2		$headers[self::HTTP_HEADER_CONTENT_TYPE] = $contentType;
125	2		}
126	3		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...
127	1		$headers[self::HTTP_HEADER_HOST] = $hosts;
128	1		}
129
130	3		return $this->ban($headers);
131			}
132
133			/**
134			* {@inheritdoc}
135			*/
136	4		public function purge($url, array $headers = [])
137			{
138	4		$this->queueRequest(self::HTTP_METHOD_PURGE, $url, $headers);
139
140	4		return $this;
141			}
142
143			/**
144			* {@inheritdoc}
145			*/
146	3	View Code Duplication	public function refresh($url, array $headers = [])
			0 ignored issues – show Duplication introduced 2017-08-09 08:00 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...
147			{
148	3		$headers = array_merge($headers, ['Cache-Control' => 'no-cache']);
149	3		$this->queueRequest(self::HTTP_METHOD_REFRESH, $url, $headers);
150
151	3		return $this;
152			}
153
154			/**
155			* {@inheritdoc}
156			*/
157	19		protected function configureOptions()
158			{
159	19		$resolver = parent::configureOptions();
160	19		$resolver->setDefaults([
161	19		'tags_header' => self::DEFAULT_HTTP_HEADER_CACHE_TAGS,
162	19		'tag_mode' => 'ban',
163	19		'header_length' => 7500,
164	19		'default_ban_headers' => [],
165	19		]);
166			// tag_mode options: 'ban', 'purge', or 'purge_single' for purge invalidation per tag
167	19		$resolver->setAllowedValues('tag_mode', ['ban', 'purge', 'purge_single']);
168	19		$resolver->setNormalizer('default_ban_headers', function ($resolver, $specified) {
169	19		return array_merge(
170			[
171	19		self::HTTP_HEADER_HOST => self::REGEX_MATCH_ALL,
172	19		self::HTTP_HEADER_URL => self::REGEX_MATCH_ALL,
173	19		self::HTTP_HEADER_CONTENT_TYPE => self::REGEX_MATCH_ALL,
174	19		],
175			$specified
176	19		);
177	19		});
178
179	19		return $resolver;
180			}
181			}
182

FriendsOfSymfony / FOSHttpCache

Pull Request — master (#332)

Varnish::ban() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like