silverstripe / cwp-core

src/Feed/CwpAtomFeed.php

Indentation +49 added lines, -49 removed lines

@@ -18,57 +18,57 @@
 
 class CwpAtomFeed extends RSSFeed
 {
-    public function __construct(
-        SS_List $entries,
-        $link,
-        $title,
-        $description = null,
-        $titleField = "Title",
-        $descriptionField = "Content",
-        $authorField = null,
-        $lastModified = null,
-        $etag = null
-    ) {
-        parent::__construct(
-            $entries,
-            $link,
-            $title,
-            $description,
-            $titleField,
-            $descriptionField,
-            $authorField,
-            $lastModified
-        );
+	public function __construct(
+		SS_List $entries,
+		$link,
+		$title,
+		$description = null,
+		$titleField = "Title",
+		$descriptionField = "Content",
+		$authorField = null,
+		$lastModified = null,
+		$etag = null
+	) {
+		parent::__construct(
+			$entries,
+			$link,
+			$title,
+			$description,
+			$titleField,
+			$descriptionField,
+			$authorField,
+			$lastModified
+		);
 
-        $this->setTemplate(__CLASS__);
-    }
+		$this->setTemplate(__CLASS__);
+	}
 
-    /**
-     * Include an link to the feed
-     *
-     * @param string $url URL of the feed
-     * @param string $title Title to show
-     */
-    public static function linkToFeed($url, $title = null)
-    {
-        $title = Convert::raw2xml($title);
-        Requirements::insertHeadTags(
-            '<link rel="alternate" type="application/atom+xml" title="' . $title .
-            '" href="' . $url . '" />'
-        );
-    }
+	/**
+	 * Include an link to the feed
+	 *
+	 * @param string $url URL of the feed
+	 * @param string $title Title to show
+	 */
+	public static function linkToFeed($url, $title = null)
+	{
+		$title = Convert::raw2xml($title);
+		Requirements::insertHeadTags(
+			'<link rel="alternate" type="application/atom+xml" title="' . $title .
+			'" href="' . $url . '" />'
+		);
+	}
 
-    /**
-     * Output the feed to the browser
-     *
-     * @return DBHTMLText
-     */
-    public function outputToBrowser()
-    {
-        $output = parent::outputToBrowser();
-        $response = Controller::curr()->getResponse();
-        $response->addHeader("Content-Type", "application/atom+xml");
+	/**
+	 * Output the feed to the browser
+	 *
+	 * @return DBHTMLText
+	 */
+	public function outputToBrowser()
+	{
+		$output = parent::outputToBrowser();
+		$response = Controller::curr()->getResponse();
+		$response->addHeader("Content-Type", "application/atom+xml");
 
-        return $output;
-    }
+		return $output;
+	}
 }

src/Extension/RichLinksExtension.php

Indentation +38 added lines, -38 removed lines

@@ -17,48 +17,48 @@
 class RichLinksExtension extends Extension
 {
 
-    /**
-     * @var array
-     */
-    private static $casting = [
-        'RichLinks' => 'HTMLText'
-    ];
+	/**
+	 * @var array
+	 */
+	private static $casting = [
+		'RichLinks' => 'HTMLText'
+	];
 
-    /**
-     * @return string
-     */
-    public function RichLinks()
-    {
-        // Note:
-        // Assume we can use Regexes because the link will always be formatted
-        // in the same way coming from the CMS.
+	/**
+	 * @return string
+	 */
+	public function RichLinks()
+	{
+		// Note:
+		// Assume we can use Regexes because the link will always be formatted
+		// in the same way coming from the CMS.
 
-        $content = $this->owner->value;
+		$content = $this->owner->value;
 
-        // Find all file links for processing.
-        preg_match_all('/<a.*href="\[file_link,id=([0-9]+)\].*".*>.*<\/a>/U', $content, $matches);
+		// Find all file links for processing.
+		preg_match_all('/<a.*href="\[file_link,id=([0-9]+)\].*".*>.*<\/a>/U', $content, $matches);
 
-        // Attach the file type and size to each of the links.
-        for ($i = 0; $i < count($matches[0]); $i++) {
-            $file = DataObject::get_by_id(File::class, $matches[1][$i]);
-            if ($file) {
-                $size = $file->getSize();
-                $ext = strtoupper($file->getExtension());
-                // Replace the closing </a> tag with the size span (and reattach the closing tag).
-                $newLink = substr($matches[0][$i], 0, strlen($matches[0][$i]) - 4)
-                    . "<span class='fileExt'> [$ext, $size]</span></a>";
-                $content = str_replace($matches[0][$i], $newLink, $content);
-            }
-        }
+		// Attach the file type and size to each of the links.
+		for ($i = 0; $i < count($matches[0]); $i++) {
+			$file = DataObject::get_by_id(File::class, $matches[1][$i]);
+			if ($file) {
+				$size = $file->getSize();
+				$ext = strtoupper($file->getExtension());
+				// Replace the closing </a> tag with the size span (and reattach the closing tag).
+				$newLink = substr($matches[0][$i], 0, strlen($matches[0][$i]) - 4)
+					. "<span class='fileExt'> [$ext, $size]</span></a>";
+				$content = str_replace($matches[0][$i], $newLink, $content);
+			}
+		}
 
-        // Inject extra attributes into the external links.
-        $pattern = '/(<a.*)(href=\"https?:\/\/[^\"]*\"[^>]*>.*)(<\/a>)/iU';
-        $replacement = sprintf(
-            '$1class="external" rel="external" title="%s" $2<span class="nonvisual-indicator">(external link)</span>$3',
-            _t(__CLASS__ . '.OpenLinkTitle', 'Open external link')
-        );
-        $content = preg_replace($pattern, $replacement, $content, -1);
+		// Inject extra attributes into the external links.
+		$pattern = '/(<a.*)(href=\"https?:\/\/[^\"]*\"[^>]*>.*)(<\/a>)/iU';
+		$replacement = sprintf(
+			'$1class="external" rel="external" title="%s" $2<span class="nonvisual-indicator">(external link)</span>$3',
+			_t(__CLASS__ . '.OpenLinkTitle', 'Open external link')
+		);
+		$content = preg_replace($pattern, $replacement, $content, -1);
 
-        return $content;
-    }
+		return $content;
+	}
 }

src/Control/InitialisationMiddleware.php

Indentation +92 added lines, -92 removed lines

@@ -12,97 +12,97 @@
  */
 class InitialisationMiddleware implements HTTPMiddleware
 {
-    use Configurable;
-
-    /**
-     * Disable the automatically added 'X-XSS-Protection' header that is added to all responses. This should be left
-     * alone in most circumstances to include the header. Refer to Mozilla Developer Network for more information:
-     * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
-     *
-     * @config
-     * @var bool
-     */
-    private static $xss_protection_enabled = true;
-
-    /**
-     * Enable egress proxy. This works on the principle of setting http(s)_proxy environment variables,
-     *  which will be automatically picked up by curl. This means RestfulService and raw curl
-     *  requests should work out of the box. Stream-based requests need extra manual configuration.
-     *  Refer to https://www.cwp.govt.nz/guides/core-technical-documentation/common-web-platform-core/en/how-tos/external_http_requests_with_proxy
-     *
-     * @config
-     * @var bool
-     */
-    private static $egress_proxy_default_enabled = true;
-
-    /**
-     * Configure the list of domains to bypass proxy by setting the NO_PROXY environment variable.
-     * 'services.cwp.govt.nz' needs to be present for Solr and Docvert internal CWP integration.
-     * 'localhost' is necessary for accessing services on the same instance such as tika-server for text extraction.
-     *
-     * @config
-     * @var string[]
-     */
-    private static $egress_proxy_exclude_domains = [
-        'services.cwp.govt.nz',
-        'localhost',
-    ];
-
-    public function process(HTTPRequest $request, callable $delegate)
-    {
-        $response = $delegate($request);
-
-        if ($this->config()->get('egress_proxy_default_enabled')) {
-            $this->configureEgressProxy();
-        }
+	use Configurable;
+
+	/**
+	 * Disable the automatically added 'X-XSS-Protection' header that is added to all responses. This should be left
+	 * alone in most circumstances to include the header. Refer to Mozilla Developer Network for more information:
+	 * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
+	 *
+	 * @config
+	 * @var bool
+	 */
+	private static $xss_protection_enabled = true;
+
+	/**
+	 * Enable egress proxy. This works on the principle of setting http(s)_proxy environment variables,
+	 *  which will be automatically picked up by curl. This means RestfulService and raw curl
+	 *  requests should work out of the box. Stream-based requests need extra manual configuration.
+	 *  Refer to https://www.cwp.govt.nz/guides/core-technical-documentation/common-web-platform-core/en/how-tos/external_http_requests_with_proxy
+	 *
+	 * @config
+	 * @var bool
+	 */
+	private static $egress_proxy_default_enabled = true;
+
+	/**
+	 * Configure the list of domains to bypass proxy by setting the NO_PROXY environment variable.
+	 * 'services.cwp.govt.nz' needs to be present for Solr and Docvert internal CWP integration.
+	 * 'localhost' is necessary for accessing services on the same instance such as tika-server for text extraction.
+	 *
+	 * @config
+	 * @var string[]
+	 */
+	private static $egress_proxy_exclude_domains = [
+		'services.cwp.govt.nz',
+		'localhost',
+	];
+
+	public function process(HTTPRequest $request, callable $delegate)
+	{
+		$response = $delegate($request);
+
+		if ($this->config()->get('egress_proxy_default_enabled')) {
+			$this->configureEgressProxy();
+		}
         
-        $this->configureProxyDomainExclusions();
-
-        if ($this->config()->get('xss_protection_enabled') && $response) {
-            $response->addHeader('X-XSS-Protection', '1; mode=block');
-        }
-
-        return $response;
-    }
-
-    /**
-     * If the outbound egress proxy details have been defined in environment variables, configure the proxy
-     * variables that are used to configure it.
-     */
-    protected function configureEgressProxy()
-    {
-        if (!Environment::getEnv('SS_OUTBOUND_PROXY')
-            || !Environment::getEnv('SS_OUTBOUND_PROXY_PORT')
-        ) {
-            return;
-        }
-
-        $proxy = Environment::getEnv('SS_OUTBOUND_PROXY');
-        $proxyPort = Environment::getEnv('SS_OUTBOUND_PROXY_PORT');
-
-        Environment::setEnv('http_proxy', $proxy . ':' . $proxyPort);
-        Environment::setEnv('https_proxy', $proxy . ':' . $proxyPort);
-    }
-
-    /**
-     * Configure any domains that should be excluded from egress proxy rules and provide them to the environment
-     */
-    protected function configureProxyDomainExclusions()
-    {
-        $noProxy = $this->config()->get('egress_proxy_exclude_domains');
-        if (empty($noProxy)) {
-            return;
-        }
-
-        if (!is_array($noProxy)) {
-            $noProxy = [$noProxy];
-        }
-
-        // Merge with exsiting if needed.
-        if (Environment::getEnv('NO_PROXY')) {
-            $noProxy = array_merge(explode(',', Environment::getEnv('NO_PROXY')), $noProxy);
-        }
-
-        Environment::setEnv('NO_PROXY', implode(',', array_unique($noProxy)));
-    }
+		$this->configureProxyDomainExclusions();
+
+		if ($this->config()->get('xss_protection_enabled') && $response) {
+			$response->addHeader('X-XSS-Protection', '1; mode=block');
+		}
+
+		return $response;
+	}
+
+	/**
+	 * If the outbound egress proxy details have been defined in environment variables, configure the proxy
+	 * variables that are used to configure it.
+	 */
+	protected function configureEgressProxy()
+	{
+		if (!Environment::getEnv('SS_OUTBOUND_PROXY')
+			|| !Environment::getEnv('SS_OUTBOUND_PROXY_PORT')
+		) {
+			return;
+		}
+
+		$proxy = Environment::getEnv('SS_OUTBOUND_PROXY');
+		$proxyPort = Environment::getEnv('SS_OUTBOUND_PROXY_PORT');
+
+		Environment::setEnv('http_proxy', $proxy . ':' . $proxyPort);
+		Environment::setEnv('https_proxy', $proxy . ':' . $proxyPort);
+	}
+
+	/**
+	 * Configure any domains that should be excluded from egress proxy rules and provide them to the environment
+	 */
+	protected function configureProxyDomainExclusions()
+	{
+		$noProxy = $this->config()->get('egress_proxy_exclude_domains');
+		if (empty($noProxy)) {
+			return;
+		}
+
+		if (!is_array($noProxy)) {
+			$noProxy = [$noProxy];
+		}
+
+		// Merge with exsiting if needed.
+		if (Environment::getEnv('NO_PROXY')) {
+			$noProxy = array_merge(explode(',', Environment::getEnv('NO_PROXY')), $noProxy);
+		}
+
+		Environment::setEnv('NO_PROXY', implode(',', array_unique($noProxy)));
+	}
 }

src/Control/CwpBasicAuthMiddleware.php

Indentation +75 added lines, -75 removed lines

@@ -8,86 +8,86 @@
 
 class CwpBasicAuthMiddleware extends BasicAuthMiddleware implements PermissionProvider
 {
-    /**
-     * Whitelisted IP addresses will not be given a basic authentication prompt when other basic authentication
-     * rules via {@link BasicAuthMiddleware} are enabled.
-     *
-     * Please note that this will not have any effect if using BasicAuth.entire_site_protected, which will
-     * always enabled basic authentication for the entire site.
-     *
-     * @var array
-     */
-    protected $whitelistedIps = [];
+	/**
+	 * Whitelisted IP addresses will not be given a basic authentication prompt when other basic authentication
+	 * rules via {@link BasicAuthMiddleware} are enabled.
+	 *
+	 * Please note that this will not have any effect if using BasicAuth.entire_site_protected, which will
+	 * always enabled basic authentication for the entire site.
+	 *
+	 * @var array
+	 */
+	protected $whitelistedIps = [];
 
-    /**
-     * @return array
-     */
-    public function getWhitelistedIps()
-    {
-        return $this->whitelistedIps;
-    }
+	/**
+	 * @return array
+	 */
+	public function getWhitelistedIps()
+	{
+		return $this->whitelistedIps;
+	}
 
-    /**
-     * @param string|string[] $whitelistedIps An array of IP addresses, or a comma delimited string
-     * @return $this
-     */
-    public function setWhitelistedIps($whitelistedIps)
-    {
-        if (is_string($whitelistedIps)) {
-            $whitelistedIps = explode(',', $whitelistedIps);
-        }
-        $this->whitelistedIps = $whitelistedIps;
-        return $this;
-    }
+	/**
+	 * @param string|string[] $whitelistedIps An array of IP addresses, or a comma delimited string
+	 * @return $this
+	 */
+	public function setWhitelistedIps($whitelistedIps)
+	{
+		if (is_string($whitelistedIps)) {
+			$whitelistedIps = explode(',', $whitelistedIps);
+		}
+		$this->whitelistedIps = $whitelistedIps;
+		return $this;
+	}
 
-    /**
-     * Check for any whitelisted IP addresses. If one matches the current user's IP then return false early,
-     * otherwise allow the default {@link BasicAuthMiddleware} to continue its logic.
-     *
-     * {@inheritDoc}
-     */
-    protected function checkMatchingURL(HTTPRequest $request)
-    {
-        if ($this->ipMatchesWhitelist()) {
-            return false;
-        }
-        return parent::checkMatchingURL($request);
-    }
+	/**
+	 * Check for any whitelisted IP addresses. If one matches the current user's IP then return false early,
+	 * otherwise allow the default {@link BasicAuthMiddleware} to continue its logic.
+	 *
+	 * {@inheritDoc}
+	 */
+	protected function checkMatchingURL(HTTPRequest $request)
+	{
+		if ($this->ipMatchesWhitelist()) {
+			return false;
+		}
+		return parent::checkMatchingURL($request);
+	}
 
-    /**
-     * Check whether the current user's IP address is in the IP whitelist
-     *
-     * @return bool
-     */
-    protected function ipMatchesWhitelist()
-    {
-        $whitelist = $this->getWhitelistedIps();
-        // Continue if no whitelist is defined
-        if (empty($whitelist)) {
-            return false;
-        }
+	/**
+	 * Check whether the current user's IP address is in the IP whitelist
+	 *
+	 * @return bool
+	 */
+	protected function ipMatchesWhitelist()
+	{
+		$whitelist = $this->getWhitelistedIps();
+		// Continue if no whitelist is defined
+		if (empty($whitelist)) {
+			return false;
+		}
 
-        $userIp = $_SERVER['REMOTE_ADDR'];
-        if (in_array($userIp, $whitelist)) {
-            return true;
-        }
+		$userIp = $_SERVER['REMOTE_ADDR'];
+		if (in_array($userIp, $whitelist)) {
+			return true;
+		}
 
-        return false;
-    }
+		return false;
+	}
 
-    /**
-     * Provide a permission code for users to be able to access the site in test mode (UAT sites). This will
-     * apply to any route other than those required to change your password.
-     *
-     * @return array
-     */
-    public function providePermissions()
-    {
-        return [
-            'ACCESS_UAT_SERVER' => _t(
-                __CLASS__ . '.UatServerPermission',
-                'Allow users to use their accounts to access the UAT server'
-            )
-        ];
-    }
+	/**
+	 * Provide a permission code for users to be able to access the site in test mode (UAT sites). This will
+	 * apply to any route other than those required to change your password.
+	 *
+	 * @return array
+	 */
+	public function providePermissions()
+	{
+		return [
+			'ACCESS_UAT_SERVER' => _t(
+				__CLASS__ . '.UatServerPermission',
+				'Allow users to use their accounts to access the UAT server'
+			)
+		];
+	}
 }

tests/Control/CwpBasicAuthMiddlewareTest.php

Indentation +88 added lines, -88 removed lines

@@ -13,92 +13,92 @@
 
 class CwpBasicAuthMiddlewareTest extends SapphireTest
 {
-    /**
-     * @var CwpBasicAuthMiddleware
-     */
-    protected $middleware;
-
-    /**
-     * @var array
-     */
-    protected $originalServersVars = [];
-
-    protected function setUp()
-    {
-        parent::setUp();
-
-        $this->middleware = Injector::inst()->get(BasicAuthMiddleware::class);
-        $this->originalServersVars = $_SERVER;
-
-        Config::modify()->set(BasicAuth::class, 'ignore_cli', false);
-    }
-
-    protected function tearDown()
-    {
-        $_SERVER = $this->originalServersVars;
-
-        parent::tearDown();
-    }
-
-    public function testSetWhitelistedIps()
-    {
-        $this->middleware->setWhitelistedIps('127.0.0.1,127.0.0.2');
-        $this->assertSame([
-            '127.0.0.1',
-            '127.0.0.2',
-        ], $this->middleware->getWhitelistedIps(), 'Accepts comma delimited strings');
-
-        $this->middleware->setWhitelistedIps(['127.0.0.1']);
-        $this->assertSame(['127.0.0.1'], $this->middleware->getWhitelistedIps(), 'Accepts array values');
-    }
-
-    /**
-     * @param string $currentIp
-     * @param int $expected
-     * @dataProvider whitelistingProvider
-     */
-    public function testIpWhitelisting($currentIp, $expected)
-    {
-        // Enable basic auth everywhere
-        $this->middleware->setURLPatterns(['#.*#' => true]);
-
-        // Set a whitelisted IP address
-        $_SERVER['REMOTE_ADDR'] = $currentIp;
-        $this->middleware->setWhitelistedIps(['127.0.0.1']);
-
-        $response = $this->mockRequest();
-
-        $this->assertEquals($expected, $response->getStatusCode());
-    }
-
-    /**
-     * @return array[]
-     */
-    public function whitelistingProvider()
-    {
-        return [
-            'IP not in whitelist' => ['123.456.789.012', 401],
-            'IP in whitelist' => ['127.0.0.1', 200],
-        ];
-    }
-
-    public function testMiddlewareProvidesUatServerPermissions()
-    {
-        $this->assertArrayHasKey('ACCESS_UAT_SERVER', $this->middleware->providePermissions());
-    }
-
-    /**
-     * Perform a mock middleware request. Will return 200 if everything is OK.
-     *
-     * @param string $url
-     * @return HTTPResponse
-     */
-    protected function mockRequest($url = '/foo')
-    {
-        $request = new HTTPRequest('GET', $url);
-
-        return $this->middleware->process($request, function () {
-            return new HTTPResponse('OK', 200);
-        });
-    }
+	/**
+	 * @var CwpBasicAuthMiddleware
+	 */
+	protected $middleware;
+
+	/**
+	 * @var array
+	 */
+	protected $originalServersVars = [];
+
+	protected function setUp()
+	{
+		parent::setUp();
+
+		$this->middleware = Injector::inst()->get(BasicAuthMiddleware::class);
+		$this->originalServersVars = $_SERVER;
+
+		Config::modify()->set(BasicAuth::class, 'ignore_cli', false);
+	}
+
+	protected function tearDown()
+	{
+		$_SERVER = $this->originalServersVars;
+
+		parent::tearDown();
+	}
+
+	public function testSetWhitelistedIps()
+	{
+		$this->middleware->setWhitelistedIps('127.0.0.1,127.0.0.2');
+		$this->assertSame([
+			'127.0.0.1',
+			'127.0.0.2',
+		], $this->middleware->getWhitelistedIps(), 'Accepts comma delimited strings');
+
+		$this->middleware->setWhitelistedIps(['127.0.0.1']);
+		$this->assertSame(['127.0.0.1'], $this->middleware->getWhitelistedIps(), 'Accepts array values');
+	}
+
+	/**
+	 * @param string $currentIp
+	 * @param int $expected
+	 * @dataProvider whitelistingProvider
+	 */
+	public function testIpWhitelisting($currentIp, $expected)
+	{
+		// Enable basic auth everywhere
+		$this->middleware->setURLPatterns(['#.*#' => true]);
+
+		// Set a whitelisted IP address
+		$_SERVER['REMOTE_ADDR'] = $currentIp;
+		$this->middleware->setWhitelistedIps(['127.0.0.1']);
+
+		$response = $this->mockRequest();
+
+		$this->assertEquals($expected, $response->getStatusCode());
+	}
+
+	/**
+	 * @return array[]
+	 */
+	public function whitelistingProvider()
+	{
+		return [
+			'IP not in whitelist' => ['123.456.789.012', 401],
+			'IP in whitelist' => ['127.0.0.1', 200],
+		];
+	}
+
+	public function testMiddlewareProvidesUatServerPermissions()
+	{
+		$this->assertArrayHasKey('ACCESS_UAT_SERVER', $this->middleware->providePermissions());
+	}
+
+	/**
+	 * Perform a mock middleware request. Will return 200 if everything is OK.
+	 *
+	 * @param string $url
+	 * @return HTTPResponse
+	 */
+	protected function mockRequest($url = '/foo')
+	{
+		$request = new HTTPRequest('GET', $url);
+
+		return $this->middleware->process($request, function () {
+			return new HTTPResponse('OK', 200);
+		});
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
     {
         $request = new HTTPRequest('GET', $url);
 
-        return $this->middleware->process($request, function () {
+        return $this->middleware->process($request, function() {
             return new HTTPResponse('OK', 200);
         });
     }