Varnish::getDefaultOptions() - Code Metrics - Inspection of "make php-http/discovery optional" - FriendsOfSymfony/FOSHttpCache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#272)

by David

created 2016-01-25 16:33 UTC

Varnish::getDefaultOptions() A

↳ Parent: Varnish

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	0
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\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
 *
 * @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)
    {
        $tagExpression = sprintf('(%s)(,.+)?$', implode('|', array_map('preg_quote', $this->escapeTags($tags))));

        return $this->ban([$this->options['tags_header'] => $tagExpression]);
    }

    /**
     * {@inheritdoc}
     */
    public function getTagsHeaderValue(array $tags)
    {
        return implode(',', 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'];
    }

    /**
     * {@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']);

        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			*
28			* @author David de Boer <[email protected]>
29			*/
30			class Varnish extends AbstractProxyClient implements BanInterface, PurgeInterface, RefreshInterface, TagsInterface
31			{
32			const HTTP_METHOD_BAN = 'BAN';
33			const HTTP_METHOD_PURGE = 'PURGE';
34			const HTTP_METHOD_REFRESH = 'GET';
35			const HTTP_HEADER_HOST = 'X-Host';
36			const HTTP_HEADER_URL = 'X-Url';
37			const HTTP_HEADER_CONTENT_TYPE = 'X-Content-Type';
38
39			/**
40			* Map of default headers for ban requests with their default values.
41			*
42			* @var array
43			*/
44			private $defaultBanHeaders = [
45			self::HTTP_HEADER_HOST => self::REGEX_MATCH_ALL,
46			self::HTTP_HEADER_URL => self::REGEX_MATCH_ALL,
47			self::HTTP_HEADER_CONTENT_TYPE => self::REGEX_MATCH_ALL
48			];
49
50			/**
51			* Set the default headers that get merged with the provided headers in self::ban().
52			*
53			* @param array $headers Hashmap with keys being the header names, values
54			* the header values.
55			*/
56	2		public function setDefaultBanHeaders(array $headers)
57			{
58	2		$this->defaultBanHeaders = $headers;
59	2		}
60
61			/**
62			* Add or overwrite a default ban header.
63			*
64			* @param string $name The name of that header
65			* @param string $value The content of that header
66			*/
67	2		public function setDefaultBanHeader($name, $value)
68			{
69	2		$this->defaultBanHeaders[$name] = $value;
70	2		}
71
72			/**
73			* {@inheritdoc}
74			*/
75	3		public function invalidateTags(array $tags)
76			{
77	3		$tagExpression = sprintf('(%s)(,.+)?$', implode('\|', array_map('preg_quote', $this->escapeTags($tags))));
78
79	3		return $this->ban([$this->options['tags_header'] => $tagExpression]);
80			}
81
82			/**
83			* {@inheritdoc}
84			*/
85			public function getTagsHeaderValue(array $tags)
86			{
87			return implode(',', array_unique($this->escapeTags($tags)));
88			}
89
90			/**
91			* Get the HTTP header name that will hold cache tags.
92			*
93			* @return string
94			*/
95			public function getTagsHeaderName()
96			{
97			return $this->options['tags_header'];
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103	11		public function ban(array $headers)
104			{
105	11		$headers = array_merge(
106	11		$this->defaultBanHeaders,
107			$headers
108	11		);
109
110	11		$this->queueRequest(self::HTTP_METHOD_BAN, '/', $headers);
111
112	11		return $this;
113			}
114
115			/**
116			* {@inheritdoc}
117			*/
118	4		public function banPath($path, $contentType = null, $hosts = null)
119			{
120	4		if (is_array($hosts)) {
121	2		if (!count($hosts)) {
122	1		throw new InvalidArgumentException('Either supply a list of hosts or null, but not an empty array.');
123			}
124	1		$hosts = '^('.join('\|', $hosts).')$';
125	1		}
126
127			$headers = [
128	3		self::HTTP_HEADER_URL => $path,
129	3		];
130
131	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...
132	2		$headers[self::HTTP_HEADER_CONTENT_TYPE] = $contentType;
133	2		}
134	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...
135	1		$headers[self::HTTP_HEADER_HOST] = $hosts;
136	1		}
137
138	3		return $this->ban($headers);
139			}
140
141			/**
142			* {@inheritdoc}
143			*/
144	11		public function purge($url, array $headers = [])
145			{
146	11		$this->queueRequest(self::HTTP_METHOD_PURGE, $url, $headers);
147
148	10		return $this;
149			}
150
151			/**
152			* {@inheritdoc}
153			*/
154	3	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...
155			{
156	3		$headers = array_merge($headers, ['Cache-Control' => 'no-cache']);
157	3		$this->queueRequest(self::HTTP_METHOD_REFRESH, $url, $headers);
158
159	3		return $this;
160			}
161
162			/**
163			* {@inheritdoc}
164			*/
165	32		protected function getDefaultOptions()
166			{
167	32		$resolver = parent::getDefaultOptions();
168	32		$resolver->setDefaults(['tags_header' => 'X-Cache-Tags']);
169
170	32		return $resolver;
171			}
172
173			/**
174			* Build the invalidation request and validate it.
175			*
176			* {@inheritdoc}
177			*
178			* @throws MissingHostException If a relative path is queued for purge/
179			* refresh and no base URL is set
180			*
181			*/
182	25		protected function queueRequest($method, $url, array $headers = [])
183			{
184	25		$request = $this->messageFactory->createRequest($method, $url, $headers);
185
186	25		if (self::HTTP_METHOD_BAN !== $method
187	25		&& null === $this->options['base_uri']
188	25		&& !$request->getHeaderLine('Host')
189	25		) {
190	1		throw MissingHostException::missingHost($url);
191			}
192
193	24		$this->httpAdapter->invalidate($request);
194	24		}
195			}
196

FriendsOfSymfony / FOSHttpCache

Pull Request — master (#272)

Varnish::getDefaultOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like