CWP\CWP\Extension\MaintenanceProxyExtension

Complexity

Total Complexity

9

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	onAfterBuild()	0	10	4
A	getCwpProxy()	0	10	3
A	updateClientOptions()	0	4	2

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 18 and the first side effect is on line 10.

namespace CWP\CWP\Extension;

use BringYourOwnIdeas\Maintenance\Reports\SiteSummary;

The type BringYourOwnIdeas\Maintenance\Reports\SiteSummary was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\Core\Environment;
use SilverStripe\Core\Extension;

if (!class_exists(SiteSummary::class)) {
    return;
}

/**
 * Used to configure proxy settings for bringyourownideas/silverstripe-maintenance and its related modules
 *
 * @see https://www.cwp.govt.nz/developer-docs/en/2/how_tos/external_http_requests_with_proxy
 */
class MaintenanceProxyExtension extends Extension
{
    /**
     * Configures required environment settings for Composer's use, applies to
     * {@link \BringYourOwnIdeas\Maintenance\Util\ComposerLoader} and is applied before ComposerLoaderExtension in
     * bringyourownideas/silverstripe-composer-update-checker to ensure the proxy information is set before Composer
     * is created
     */
    public function onAfterBuild()
    {
        // Mock COMPOSER_HOME if it's not defined already. Composer requires one of the two to be set.
        if (!Environment::getEnv('HOME') && !Environment::getEnv('COMPOSER_HOME')) {
            putenv('COMPOSER_HOME=/tmp');
        }

        // Provide access for Composer's StreamContextFactory, since it creates its own stream context
        if ($proxy = $this->getCwpProxy()) {
            $_SERVER['CGI_HTTP_PROXY'] = $proxy;
        }
    }

    /**
     * Provide proxy options for {@link \BringYourOwnIdeas\Maintenance\Util\ApiLoader} instances to use in
     * their Guzzle clients
     *
     * @param array $options
     */
    public function updateClientOptions(&$options)
    {
        if ($proxy = $this->getCwpProxy()) {
            $options['proxy'] = $proxy;
        }
    }

    /**
     * Returns a formatted CWP proxy string, e.g. `tcp://proxy.cwp.govt.nz:1234`
     *
     * @return string
     */
    protected function getCwpProxy()
    {
        if (!Environment::getEnv('SS_OUTBOUND_PROXY') || !Environment::getEnv('SS_OUTBOUND_PROXY_PORT')) {
            return '';
        }

        return sprintf(
            'tcp://%s:%d',
            Environment::getEnv('SS_OUTBOUND_PROXY'),
            Environment::getEnv('SS_OUTBOUND_PROXY_PORT')
        );
    }
}