FOS\HttpCache\SymfonyCache\PurgeSubscriber

Complexity

Total Complexity

7

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

87.1%

Importance

Changes	6
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	2
A	getSubscribedEvents()	0	6	1
A	handlePurge()	0	21	4

<?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\SymfonyCache;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestMatcher;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Purge handler for the symfony built-in HttpCache.
 *
 * @author David Buchmann <mail@davidbu.ch>
 *
 * {@inheritdoc}
 */
class PurgeSubscriber extends AccessControlledSubscriber
{
    const DEFAULT_PURGE_METHOD = 'PURGE';

    /**
     * The options configured in the constructor argument or default values.
     *
     * @var array
     */
    private $options = [];

    /**
     * When creating this subscriber, you can configure a number of options.
     *
     * - purge_method:         HTTP method that identifies purge requests.
     * - purge_client_matcher: RequestMatcher to identify valid purge clients.
     * - purge_client_ips:     IP or array of IPs that are allowed to purge.
     *
     * Only set one of purge_client_ips and purge_client_matcher.
     *
     * @param array $options Options to overwrite the default options
     *
     * @throws \InvalidArgumentException if unknown keys are found in $options
     */
    public function __construct(array $options = [])
    {
        $resolver = new OptionsResolver();
        if (method_exists($resolver, 'setDefined')) {
            // this was only added in symfony 2.6
            $resolver->setDefined(['purge_client_matcher', 'purge_client_ips', 'purge_method']);
        } else {
            $resolver->setOptional(['purge_client_matcher', 'purge_client_ips', 'purge_method']);

The method setOptional() does not seem to exist on object<Symfony\Component\OptionsResolver\OptionsResolver>.

        }
        $resolver->setDefaults([
            'purge_client_matcher' => null,
            'purge_client_ips' => null,
            'purge_method' => static::DEFAULT_PURGE_METHOD,
        ]);

        $this->options = $resolver->resolve($options);

        parent::__construct($this->options['purge_client_matcher'], $this->options['purge_client_ips']);
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [
            Events::PRE_INVALIDATE => 'handlePurge',
        ];
    }

    /**
     * Look at unsafe requests and handle purge requests.
     *
     * Prevents access when the request comes from a non-authorized client.
     *
     * @param CacheEvent $event
     */
    public function handlePurge(CacheEvent $event)
    {
        $request = $event->getRequest();
        if ($this->options['purge_method'] !== $request->getMethod()) {
            return;
        }

        if (!$this->isRequestAllowed($request)) {
            $event->setResponse(new Response('', 400));

            return;
        }

        $response = new Response();
        if ($event->getKernel()->getStore()->purge($request->getUri())) {
            $response->setStatusCode(200, 'Purged');
        } else {
            $response->setStatusCode(200, 'Not found');
        }
        $event->setResponse($response);
    }
}