FOS\HttpCache\ProxyClient\LiteSpeed

Complexity

Total Complexity

6

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	clear()	0	8	1
A	purge()	0	12	2
A	invalidateTags()	0	8	1
A	refresh()	0	7	1
A	queuePurgeRequest()	0	8	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\ProxyClient\Invalidation\ClearCapable;
use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
use FOS\HttpCache\ProxyClient\Invalidation\RefreshCapable;
use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;

/**
 * LiteSpeed (OpenLiteSpeed or LiteSpeed Web Server) invalidator.
 *
 * @author Yanick Witschi <yanick.witschi@terminal42.ch>
 */
class LiteSpeed extends HttpProxyClient implements PurgeCapable, TagCapable, ClearCapable, RefreshCapable
{
    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        $this->queuePurgeRequest([
            'X-LiteSpeed-Purge' => '*',
        ]);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function purge($url, array $headers = [])
    {
        // LiteSpeed only supports purging by relative URLs
        $urlParts = parse_url($url);
        $url = array_key_exists('path', $urlParts) ? $urlParts['path'] : '/';

        $this->queuePurgeRequest([
            'X-LiteSpeed-Purge' => $url,
        ]);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function invalidateTags(array $tags)
    {
        $this->queuePurgeRequest([
            'X-LiteSpeed-Purge' => implode(', ', preg_filter('/^/', 'tag=', $tags)),
        ]);

        return $this;
    }

    private function queuePurgeRequest(array $headers)
    {
        // TODO: LiteSpeed is likely going to hard code this URL, otherwise it has to be configurable
        $purgeEndpoint = '/_fos_litespeed_purge_endpoint/';
        $headers['Authorization'] = 'Basic Zm9zOmZvczEyMw=='; // fos:fos123

        $this->queueRequest('PURGE', $purgeEndpoint, $headers);
    }

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

        return $this;
    }
}