SilverStripe\StaticPublishQueue\Service\URLSanitisationService

Complexity

Total Complexity

12

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	addURLs()	0	4	2
A	getURLs()	0	7	2
A	getForceSSL()	0	3	1
A	addURL()	0	14	2
A	enforceSSL()	0	8	2
A	removeStageParam()	0	9	1
A	enforceTrailingSlash()	0	11	2

<?php

namespace SilverStripe\StaticPublishQueue\Service;

use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Injector\Injectable;

/**
 * Class URLSanitisationService
 * Provides an abstraction for populating and generating a list of
 * URLs to be cached by StaticPublishQueue.
 *
 * @package SilverStripe\StaticPublishQueue\Service
 */
class URLSanitisationService
{
    use Configurable;
    use Injectable;

    /**
     * Enable to force all URLs to be changed to https
     *
     * @var bool
     * @config
     */
    private static $force_ssl = false;

The private property $force_ssl is not used, and could be removed.

    /**
     * @var array
     */
    private $urls = [];

    /**
     * @var int
     */
    private $pointer = 0;

    /**
     * @param string $url
     */
    public function addURL($url)
    {
        $url = $this->removeStageParam($url);
        $url = $this->enforceTrailingSlash($url);
        $url = $this->enforceSSL($url);

        // Check if this URL is already represented.
        if (array_key_exists($url, $this->urls)) {
            // Don't need to add it again if it is.
            return;
        }

        $this->urls[$url] = $this->pointer;
        $this->pointer += 1;
    }

    /**
     * @param array $urls
     */
    public function addURLs(array $urls)
    {
        foreach ($urls as $url) {
            $this->addURL($url);
        }
    }

    /**
     * @return array
     */
    public function getURLs($formatted = false)
    {
        if ($formatted) {
            return $this->urls;
        }

        return array_keys($this->urls);
    }

    /**
     * We never want to have stage=Stage present in our cached URLs. This will safely remove "stage" params, but
     * keep any others. It doesn't matter where in the string "stage=" exists.
     * this issue is caused by VersionedStateExtension::updateLink() which injects stage param into URLs
     * param injection happens when $readingMode !== get_default_reading_mode()
     * we can't enforce properly set reading modes while collecting URLs as the urlsToCache is an interface
     * while this doesn't seem to happen in majority cases, it's better to be 100% sure
     *
     * @param string $url
     * @return string
     */
    protected function removeStageParam($url)
    {
        $url = preg_replace('/([?&])stage=[^&]+(&|$)/', '$1', $url);

        // Trim any trailing "?" or "&".
        $url = rtrim($url, '&');
        $url = rtrim($url, '?');

        return $url;
    }

    /**
     * Make sure we don't have multiple variations of the same URL (with and without trailing slash)
     *
     * @param string $url
     * @return string
     */
    protected function enforceTrailingSlash($url)
    {
        $query = parse_url($url, PHP_URL_QUERY);
        $queryString = strlen($query) > 0
            ? '?' . $query
            : '';

        $url = str_replace('?' . $query, '', $url);
        $url = rtrim($url, '/') . '/';

        return $url . $queryString;
    }

    /**
     * Force SSL if needed
     *
     * @param string $url
     * @return string
     */
    protected function enforceSSL($url)
    {
        $forceSSL = $this->getForceSSL();
        if (!$forceSSL) {
            return $url;
        }

        return str_replace('http://', 'https://', $url);
    }

    /**
     * Override this function if runtime change is needed (CMS setting or Environment variable)
     *
     * @return bool
     */
    protected function getForceSSL()
    {
        return (bool) $this->config()->get('force_ssl');
    }
}