silverstripe / silverstripe-environmentcheck

tests/Checks/CacheHeadersCheckTest.php

Indentation +72 added lines, -72 removed lines

@@ -15,87 +15,87 @@
  */
 class CacheHeadersCheckTest extends SapphireTest
 {
-    /**
-     * Test that directives that must be included, are.
-     *
-     * @return void
-     */
-    public function testMustInclude()
-    {
-        // Create a mock and queue responses
-        $mock = new MockHandler([
-            new Response(200, ['Cache-Control' => 'must-revalidate', 'ETag' => '123']),
-            new Response(200, ['Cache-Control' =>'no-cache', 'ETag' => '123']),
-            new Response(200, ['ETag' => '123']),
-            new Response(200, ['Cache-Control' => 'must-revalidate, private', 'ETag' => '123']),
-        ]);
+	/**
+	 * Test that directives that must be included, are.
+	 *
+	 * @return void
+	 */
+	public function testMustInclude()
+	{
+		// Create a mock and queue responses
+		$mock = new MockHandler([
+			new Response(200, ['Cache-Control' => 'must-revalidate', 'ETag' => '123']),
+			new Response(200, ['Cache-Control' =>'no-cache', 'ETag' => '123']),
+			new Response(200, ['ETag' => '123']),
+			new Response(200, ['Cache-Control' => 'must-revalidate, private', 'ETag' => '123']),
+		]);
 
-        $handler = HandlerStack::create($mock);
-        $client = new Client(['handler' => $handler]);
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
 
-        $cacheHeadersCheck = new CacheHeadersCheck('/', ['must-revalidate']);
-        $cacheHeadersCheck->client = $client;
+		$cacheHeadersCheck = new CacheHeadersCheck('/', ['must-revalidate']);
+		$cacheHeadersCheck->client = $client;
 
-        // Run checks for each response above
-        $this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
-    }
+		// Run checks for each response above
+		$this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
+	}
 
-    /**
-     * Test that directives that must be excluded, are.
-     *
-     * @return void
-     */
-    public function testMustExclude()
-    {
-        // Create a mock and queue responses
-        $mock = new MockHandler([
-            new Response(200, ['Cache-Control' => 'must-revalidate', 'ETag' => '123']),
-            new Response(200, ['Cache-Control' =>'no-cache', 'ETag' => '123']),
-            new Response(200, ['ETag' => '123']),
-            new Response(200, ['Cache-Control' =>'private, no-store', ' ETag' => '123']),
-        ]);
+	/**
+	 * Test that directives that must be excluded, are.
+	 *
+	 * @return void
+	 */
+	public function testMustExclude()
+	{
+		// Create a mock and queue responses
+		$mock = new MockHandler([
+			new Response(200, ['Cache-Control' => 'must-revalidate', 'ETag' => '123']),
+			new Response(200, ['Cache-Control' =>'no-cache', 'ETag' => '123']),
+			new Response(200, ['ETag' => '123']),
+			new Response(200, ['Cache-Control' =>'private, no-store', ' ETag' => '123']),
+		]);
 
-        $handler = HandlerStack::create($mock);
-        $client = new Client(['handler' => $handler]);
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
 
-        $cacheHeadersCheck = new CacheHeadersCheck('/', [], ["no-store", "no-cache", "private"]);
-        $cacheHeadersCheck->client = $client;
+		$cacheHeadersCheck = new CacheHeadersCheck('/', [], ["no-store", "no-cache", "private"]);
+		$cacheHeadersCheck->client = $client;
 
-        // Run checks for each response above
-        $this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
-    }
+		// Run checks for each response above
+		$this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
+	}
 
-    /**
-     * Test that Etag header must exist in response.
-     *
-     * @return void
-     */
-    public function testEtag()
-    {
-        // Create a mock and queue responses
-        $mock = new MockHandler([
-            new Response(200, ['Cache-Control' => 'must-revalidate', 'ETag' => '123']),
-            new Response(200, ['Cache-Control' =>'no-cache']),
-            new Response(200, ['ETag' => '123']),
-            new Response(200, []),
-        ]);
+	/**
+	 * Test that Etag header must exist in response.
+	 *
+	 * @return void
+	 */
+	public function testEtag()
+	{
+		// Create a mock and queue responses
+		$mock = new MockHandler([
+			new Response(200, ['Cache-Control' => 'must-revalidate', 'ETag' => '123']),
+			new Response(200, ['Cache-Control' =>'no-cache']),
+			new Response(200, ['ETag' => '123']),
+			new Response(200, []),
+		]);
 
-        $handler = HandlerStack::create($mock);
-        $client = new Client(['handler' => $handler]);
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
 
-        $cacheHeadersCheck = new CacheHeadersCheck('/');
-        $cacheHeadersCheck->client = $client;
+		$cacheHeadersCheck = new CacheHeadersCheck('/');
+		$cacheHeadersCheck->client = $client;
 
-        // Run checks for each response above
-        $this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
-        $this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
-    }
+		// Run checks for each response above
+		$this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::OK, $cacheHeadersCheck->check());
+		$this->assertContains(EnvironmentCheck::ERROR, $cacheHeadersCheck->check());
+	}
 }

tests/Checks/SessionCheckTest.php

Indentation +50 added lines, -50 removed lines

@@ -15,62 +15,62 @@
  */
 class SessionCheckTest extends SapphireTest
 {
-    /**
-     * @var SilverStripe\EnvironmentCheck\Checks\SessionCheck
-     */
-    public $sessionCheck = null;
+	/**
+	 * @var SilverStripe\EnvironmentCheck\Checks\SessionCheck
+	 */
+	public $sessionCheck = null;
 
-    /**
-     * Create a session check for use by tests.
-     *
-     * @return void
-     */
-    protected function setUp()
-    {
-        parent::setUp();
-        $this->sessionCheck = new SessionCheck('/');
-    }
+	/**
+	 * Create a session check for use by tests.
+	 *
+	 * @return void
+	 */
+	protected function setUp()
+	{
+		parent::setUp();
+		$this->sessionCheck = new SessionCheck('/');
+	}
 
-    /**
-     * Env check reports error when session cookies are being set.
-     *
-     * @return void
-     */
-    public function testSessionSet()
-    {
-        // Create a mock and queue two responses.
-        $mock = new MockHandler([
-            new Response(200, ['Set-Cookie' => 'PHPSESSID:foo']),
-            new Response(200, ['Set-Cookie' => 'SECSESSID:bar'])
-        ]);
+	/**
+	 * Env check reports error when session cookies are being set.
+	 *
+	 * @return void
+	 */
+	public function testSessionSet()
+	{
+		// Create a mock and queue two responses.
+		$mock = new MockHandler([
+			new Response(200, ['Set-Cookie' => 'PHPSESSID:foo']),
+			new Response(200, ['Set-Cookie' => 'SECSESSID:bar'])
+		]);
 
-        $handler = HandlerStack::create($mock);
-        $client = new Client(['handler' => $handler]);
-        $this->sessionCheck->client = $client;
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
+		$this->sessionCheck->client = $client;
 
-        // Check for PHPSESSID
-        $this->assertContains(EnvironmentCheck::ERROR, $this->sessionCheck->check());
+		// Check for PHPSESSID
+		$this->assertContains(EnvironmentCheck::ERROR, $this->sessionCheck->check());
 
-        // Check for SECSESSID
-        $this->assertContains(EnvironmentCheck::ERROR, $this->sessionCheck->check());
-    }
+		// Check for SECSESSID
+		$this->assertContains(EnvironmentCheck::ERROR, $this->sessionCheck->check());
+	}
 
-    /**
-     * Env check responds OK when no session cookies are set in response.
-     *
-     * @return void
-     */
-    public function testSessionNotSet()
-    {
-        // Create a mock and queue two responses.
-        $mock = new MockHandler([
-            new Response(200)
-        ]);
+	/**
+	 * Env check responds OK when no session cookies are set in response.
+	 *
+	 * @return void
+	 */
+	public function testSessionNotSet()
+	{
+		// Create a mock and queue two responses.
+		$mock = new MockHandler([
+			new Response(200)
+		]);
 
-        $handler = HandlerStack::create($mock);
-        $client = new Client(['handler' => $handler]);
-        $this->sessionCheck->client = $client;
+		$handler = HandlerStack::create($mock);
+		$client = new Client(['handler' => $handler]);
+		$this->sessionCheck->client = $client;
 
-        $this->assertContains(EnvironmentCheck::OK, $this->sessionCheck->check());
-    }
+		$this->assertContains(EnvironmentCheck::OK, $this->sessionCheck->check());
+	}
 }

src/Services/ClientFactory.php

Indentation +29 added lines, -29 removed lines

@@ -14,36 +14,36 @@
  */
 class ClientFactory implements Factory
 {
-    use Configurable;
+	use Configurable;
 
-    /**
-     * Default config for Guzzle client.
-     *
-     * @var array
-     */
-    private static $default_config = [];
+	/**
+	 * Default config for Guzzle client.
+	 *
+	 * @var array
+	 */
+	private static $default_config = [];
 
-    /**
-     * Wrapper to create a Guzzle client.
-     *
-     * {@inheritdoc}
-     */
-    public function create($service, array $params = [])
-    {
-        return new GuzzleClient($this->getConfig($params));
-    }
+	/**
+	 * Wrapper to create a Guzzle client.
+	 *
+	 * {@inheritdoc}
+	 */
+	public function create($service, array $params = [])
+	{
+		return new GuzzleClient($this->getConfig($params));
+	}
 
-    /**
-     * Merge config provided from yaml with default config
-     *
-     * @param array $overrides
-     * @return array
-     */
-    public function getConfig(array $overrides)
-    {
-        return array_merge(
-            $this->config()->get('default_config'),
-            $overrides
-        );
-    }
+	/**
+	 * Merge config provided from yaml with default config
+	 *
+	 * @param array $overrides
+	 * @return array
+	 */
+	public function getConfig(array $overrides)
+	{
+		return array_merge(
+			$this->config()->get('default_config'),
+			$overrides
+		);
+	}
 }

src/Traits/Fetcher.php

Indentation +34 added lines, -34 removed lines

@@ -11,41 +11,41 @@
  */
 trait Fetcher
 {
-    /**
-     * Client for making requests, set vi Injector.
-     *
-     * @see SilverStripe\EnvironmentCheck\Services
-     *
-     * @var GuzzleHttp\Client
-     */
-    public $client = null;
+	/**
+	 * Client for making requests, set vi Injector.
+	 *
+	 * @see SilverStripe\EnvironmentCheck\Services
+	 *
+	 * @var GuzzleHttp\Client
+	 */
+	public $client = null;
 
-    /**
-     * Absolute URL for requests.
-     *
-     * @var string
-     */
-    protected $url;
+	/**
+	 * Absolute URL for requests.
+	 *
+	 * @var string
+	 */
+	protected $url;
 
-    /**
-     * Set URL for requests.
-     *
-     * @param string $url Relative URL
-     * @return self
-     */
-    public function setURL($url)
-    {
-        $this->url = Director::absoluteURL($url);
-        return $this;
-    }
+	/**
+	 * Set URL for requests.
+	 *
+	 * @param string $url Relative URL
+	 * @return self
+	 */
+	public function setURL($url)
+	{
+		$this->url = Director::absoluteURL($url);
+		return $this;
+	}
 
-    /**
-     * Getter for URL
-     *
-     * @return string
-     */
-    public function getURL()
-    {
-        return $this->url;
-    }
+	/**
+	 * Getter for URL
+	 *
+	 * @return string
+	 */
+	public function getURL()
+	{
+		return $this->url;
+	}
 }

src/Controllers/DevCheckController.php

Indentation +35 added lines, -35 removed lines

@@ -14,39 +14,39 @@
  */
 class DevCheckController extends Controller
 {
-    /**
-     * @var array
-     */
-    private static $allowed_actions = [
-        'index'
-    ];
-
-    /**
-     * Permission code to check for access to this controller.
-     *
-     * @var string
-     */
-    private static $permission = 'ADMIN';
-
-    /**
-     * @param HTTPRequest $request
-     *
-     * @return EnvironmentChecker
-     *
-     * @throws HTTPResponse_Exception
-     */
-    public function index($request)
-    {
-        $suite = 'check';
-
-        if ($name = $request->param('Suite')) {
-            $suite = $name;
-        }
-
-        $checker = new EnvironmentChecker($suite, 'Environment status');
-        $checker->setRequest($request);
-        $checker->init($this->config()->permission);
-
-        return $checker;
-    }
+	/**
+	 * @var array
+	 */
+	private static $allowed_actions = [
+		'index'
+	];
+
+	/**
+	 * Permission code to check for access to this controller.
+	 *
+	 * @var string
+	 */
+	private static $permission = 'ADMIN';
+
+	/**
+	 * @param HTTPRequest $request
+	 *
+	 * @return EnvironmentChecker
+	 *
+	 * @throws HTTPResponse_Exception
+	 */
+	public function index($request)
+	{
+		$suite = 'check';
+
+		if ($name = $request->param('Suite')) {
+			$suite = $name;
+		}
+
+		$checker = new EnvironmentChecker($suite, 'Environment status');
+		$checker->setRequest($request);
+		$checker->init($this->config()->permission);
+
+		return $checker;
+	}
 }

src/EnvironmentChecker.php

Indentation +275 added lines, -275 removed lines

@@ -23,279 +23,279 @@
  */
 class EnvironmentChecker extends RequestHandler
 {
-    /**
-     * @var array
-     */
-    private static $url_handlers = [
-        '' => 'index',
-    ];
-
-    /**
-     * @var string
-     */
-    protected $checkSuiteName;
-
-    /**
-     * @var string
-     */
-    protected $title;
-
-    /**
-     * @var int
-     */
-    protected $errorCode = 500;
-
-    /**
-     * @var null|string
-     */
-    private static $to_email_address = null;
-
-    /**
-     * @var null|string
-     */
-    private static $from_email_address = null;
-
-    /**
-     * @var bool
-     */
-    private static $email_results = false;
-
-    /**
-     * @var bool Log results via {@link \Psr\Log\LoggerInterface}
-     */
-    private static $log_results_warning = false;
-
-    /**
-     * @var string Maps to {@link \Psr\Log\LogLevel} levels. Defaults to LogLevel::WARNING
-     */
-    private static $log_results_warning_level = LogLevel::WARNING;
-
-    /**
-     * @var bool Log results via a {@link \Psr\Log\LoggerInterface}
-     */
-    private static $log_results_error = false;
-
-    /**
-     * @var int Maps to {@link \Psr\Log\LogLevel} levels. Defaults to LogLevel::ALERT
-     */
-    private static $log_results_error_level = LogLevel::ALERT;
-
-    /**
-     * @param string $checkSuiteName
-     * @param string $title
-     */
-    public function __construct($checkSuiteName, $title)
-    {
-        parent::__construct();
-
-        $this->checkSuiteName = $checkSuiteName;
-        $this->title = $title;
-    }
-
-    /**
-     * @param string $permission
-     *
-     * @throws HTTPResponse_Exception
-     */
-    public function init($permission = 'ADMIN')
-    {
-        // if the environment supports it, provide a basic auth challenge and see if it matches configured credentials
-        if (Environment::getEnv('ENVCHECK_BASICAUTH_USERNAME')
-            && Environment::getEnv('ENVCHECK_BASICAUTH_PASSWORD')
-        ) {
-            // Check that details are both provided, and match
-            if (empty($_SERVER['PHP_AUTH_USER']) || empty($_SERVER['PHP_AUTH_PW'])
-                || $_SERVER['PHP_AUTH_USER'] != Environment::getEnv('ENVCHECK_BASICAUTH_USERNAME')
-                || $_SERVER['PHP_AUTH_PW'] != Environment::getEnv('ENVCHECK_BASICAUTH_PASSWORD')
-            ) {
-                // Fail check with basic auth challenge
-                $response = new HTTPResponse(null, 401);
-                $response->addHeader('WWW-Authenticate', "Basic realm=\"Environment check\"");
-                throw new HTTPResponse_Exception($response);
-            }
-        } elseif (!$this->canAccess(null, $permission)) {
-            // Fail check with silverstripe login challenge
-            $result = Security::permissionFailure(
-                $this,
-                "You must have the {$permission} permission to access this check"
-            );
-            throw new HTTPResponse_Exception($result);
-        }
-    }
-
-    /**
-     * Determine if the current member can access the environment checker
-     *
-     * @param null|int|Member $member
-     * @param string          $permission
-     * @return bool
-     */
-    public function canAccess($member = null, $permission = 'ADMIN')
-    {
-        if (!$member) {
-            $member = Security::getCurrentUser();
-        }
-
-        // We allow access to this controller regardless of live-status or ADMIN permission only
-        // if on CLI.  Access to this controller is always allowed in "dev-mode", or of the user is ADMIN.
-        if (Director::isDev()
-            || Director::is_cli()
-            || empty($permission)
-            || Permission::checkMember($member, $permission)
-        ) {
-            return true;
-        }
-
-        // Extended access checks.
-        // "Veto" style, return NULL to abstain vote.
-        $canExtended = null;
-        $results = $this->extend('canAccess', $member);
-        if ($results && is_array($results)) {
-            if (!min($results)) {
-                return false;
-            }
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * @return HTTPResponse
-     */
-    public function index()
-    {
-        $response = new HTTPResponse;
-        $result = EnvironmentCheckSuite::inst($this->checkSuiteName)->run();
-
-        if (!$result->ShouldPass()) {
-            $response->setStatusCode($this->errorCode);
-        }
-
-        $resultText = $result->customise([
-            'URL'       => Director::absoluteBaseURL(),
-            'Title'     => $this->title,
-            'Name'      => $this->checkSuiteName,
-            'ErrorCode' => $this->errorCode,
-        ])->renderWith(__CLASS__);
-
-        if ($this->config()->get('email_results') && !$result->ShouldPass()) {
-            $email = new Email(
-                $this->config()->get('from_email_address'),
-                $this->config()->get('to_email_address'),
-                $this->title,
-                $resultText
-            );
-            $email->send();
-        }
-
-        // Optionally log errors and warnings individually
-        foreach ($result->Details() as $detail) {
-            if ($this->config()->get('log_results_warning') && $detail->StatusCode == EnvironmentCheck::WARNING) {
-                $this->log(
-                    sprintf('EnvironmentChecker warning at "%s" check. Message: %s', $detail->Check, $detail->Message),
-                    $this->config()->get('log_results_warning_level')
-                );
-            } elseif ($this->config()->get('log_results_error') && $detail->StatusCode == EnvironmentCheck::ERROR) {
-                $this->log(
-                    sprintf('EnvironmentChecker error at "%s" check. Message: %s', $detail->Check, $detail->Message),
-                    $this->config()->get('log_results_error_level')
-                );
-            }
-        }
-
-        // output the result as JSON if requested
-        if ($this->getRequest()->getExtension() == 'json'
-            || strpos($this->getRequest()->getHeader('Accept'), 'application/json') !== false
-        ) {
-            $response->setBody($result->toJSON());
-            $response->addHeader('Content-Type', 'application/json');
-            return $response;
-        }
-
-        $response->setBody($resultText);
-
-        return $response;
-    }
-
-    /**
-     * Sends a log entry to the configured PSR-3 LoggerInterface
-     *
-     * @param string $message
-     * @param int    $level
-     */
-    public function log($message, $level)
-    {
-        Injector::inst()->get(LoggerInterface::class)->log($level, $message);
-    }
-
-    /**
-     * Set the HTTP status code that should be returned when there's an error.
-     *
-     * @param int $errorCode
-     */
-    public function setErrorCode($errorCode)
-    {
-        $this->errorCode = $errorCode;
-    }
-
-    /**
-     * @deprecated
-     * @param string $from
-     */
-    public static function set_from_email_address($from)
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        static::config()->set('from_email_address', $from);
-    }
-
-    /**
-     * @deprecated
-     * @return null|string
-     */
-    public static function get_from_email_address()
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        return static::config()->get('from_email_address');
-    }
-
-    /**
-     * @deprecated
-     * @param string $to
-     */
-    public static function set_to_email_address($to)
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        static::config()->set('to_email_address', $to);
-    }
-
-    /**
-     * @deprecated
-     * @return null|string
-     */
-    public static function get_to_email_address()
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        return static::config()->get('to_email_address');
-    }
-
-    /**
-     * @deprecated
-     * @param bool $results
-     */
-    public static function set_email_results($results)
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        static::config()->set('email_results', $results);
-    }
-
-    /**
-     * @deprecated
-     * @return bool
-     */
-    public static function get_email_results()
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        return static::config()->get('email_results');
-    }
+	/**
+	 * @var array
+	 */
+	private static $url_handlers = [
+		'' => 'index',
+	];
+
+	/**
+	 * @var string
+	 */
+	protected $checkSuiteName;
+
+	/**
+	 * @var string
+	 */
+	protected $title;
+
+	/**
+	 * @var int
+	 */
+	protected $errorCode = 500;
+
+	/**
+	 * @var null|string
+	 */
+	private static $to_email_address = null;
+
+	/**
+	 * @var null|string
+	 */
+	private static $from_email_address = null;
+
+	/**
+	 * @var bool
+	 */
+	private static $email_results = false;
+
+	/**
+	 * @var bool Log results via {@link \Psr\Log\LoggerInterface}
+	 */
+	private static $log_results_warning = false;
+
+	/**
+	 * @var string Maps to {@link \Psr\Log\LogLevel} levels. Defaults to LogLevel::WARNING
+	 */
+	private static $log_results_warning_level = LogLevel::WARNING;
+
+	/**
+	 * @var bool Log results via a {@link \Psr\Log\LoggerInterface}
+	 */
+	private static $log_results_error = false;
+
+	/**
+	 * @var int Maps to {@link \Psr\Log\LogLevel} levels. Defaults to LogLevel::ALERT
+	 */
+	private static $log_results_error_level = LogLevel::ALERT;
+
+	/**
+	 * @param string $checkSuiteName
+	 * @param string $title
+	 */
+	public function __construct($checkSuiteName, $title)
+	{
+		parent::__construct();
+
+		$this->checkSuiteName = $checkSuiteName;
+		$this->title = $title;
+	}
+
+	/**
+	 * @param string $permission
+	 *
+	 * @throws HTTPResponse_Exception
+	 */
+	public function init($permission = 'ADMIN')
+	{
+		// if the environment supports it, provide a basic auth challenge and see if it matches configured credentials
+		if (Environment::getEnv('ENVCHECK_BASICAUTH_USERNAME')
+			&& Environment::getEnv('ENVCHECK_BASICAUTH_PASSWORD')
+		) {
+			// Check that details are both provided, and match
+			if (empty($_SERVER['PHP_AUTH_USER']) || empty($_SERVER['PHP_AUTH_PW'])
+				|| $_SERVER['PHP_AUTH_USER'] != Environment::getEnv('ENVCHECK_BASICAUTH_USERNAME')
+				|| $_SERVER['PHP_AUTH_PW'] != Environment::getEnv('ENVCHECK_BASICAUTH_PASSWORD')
+			) {
+				// Fail check with basic auth challenge
+				$response = new HTTPResponse(null, 401);
+				$response->addHeader('WWW-Authenticate', "Basic realm=\"Environment check\"");
+				throw new HTTPResponse_Exception($response);
+			}
+		} elseif (!$this->canAccess(null, $permission)) {
+			// Fail check with silverstripe login challenge
+			$result = Security::permissionFailure(
+				$this,
+				"You must have the {$permission} permission to access this check"
+			);
+			throw new HTTPResponse_Exception($result);
+		}
+	}
+
+	/**
+	 * Determine if the current member can access the environment checker
+	 *
+	 * @param null|int|Member $member
+	 * @param string          $permission
+	 * @return bool
+	 */
+	public function canAccess($member = null, $permission = 'ADMIN')
+	{
+		if (!$member) {
+			$member = Security::getCurrentUser();
+		}
+
+		// We allow access to this controller regardless of live-status or ADMIN permission only
+		// if on CLI.  Access to this controller is always allowed in "dev-mode", or of the user is ADMIN.
+		if (Director::isDev()
+			|| Director::is_cli()
+			|| empty($permission)
+			|| Permission::checkMember($member, $permission)
+		) {
+			return true;
+		}
+
+		// Extended access checks.
+		// "Veto" style, return NULL to abstain vote.
+		$canExtended = null;
+		$results = $this->extend('canAccess', $member);
+		if ($results && is_array($results)) {
+			if (!min($results)) {
+				return false;
+			}
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * @return HTTPResponse
+	 */
+	public function index()
+	{
+		$response = new HTTPResponse;
+		$result = EnvironmentCheckSuite::inst($this->checkSuiteName)->run();
+
+		if (!$result->ShouldPass()) {
+			$response->setStatusCode($this->errorCode);
+		}
+
+		$resultText = $result->customise([
+			'URL'       => Director::absoluteBaseURL(),
+			'Title'     => $this->title,
+			'Name'      => $this->checkSuiteName,
+			'ErrorCode' => $this->errorCode,
+		])->renderWith(__CLASS__);
+
+		if ($this->config()->get('email_results') && !$result->ShouldPass()) {
+			$email = new Email(
+				$this->config()->get('from_email_address'),
+				$this->config()->get('to_email_address'),
+				$this->title,
+				$resultText
+			);
+			$email->send();
+		}
+
+		// Optionally log errors and warnings individually
+		foreach ($result->Details() as $detail) {
+			if ($this->config()->get('log_results_warning') && $detail->StatusCode == EnvironmentCheck::WARNING) {
+				$this->log(
+					sprintf('EnvironmentChecker warning at "%s" check. Message: %s', $detail->Check, $detail->Message),
+					$this->config()->get('log_results_warning_level')
+				);
+			} elseif ($this->config()->get('log_results_error') && $detail->StatusCode == EnvironmentCheck::ERROR) {
+				$this->log(
+					sprintf('EnvironmentChecker error at "%s" check. Message: %s', $detail->Check, $detail->Message),
+					$this->config()->get('log_results_error_level')
+				);
+			}
+		}
+
+		// output the result as JSON if requested
+		if ($this->getRequest()->getExtension() == 'json'
+			|| strpos($this->getRequest()->getHeader('Accept'), 'application/json') !== false
+		) {
+			$response->setBody($result->toJSON());
+			$response->addHeader('Content-Type', 'application/json');
+			return $response;
+		}
+
+		$response->setBody($resultText);
+
+		return $response;
+	}
+
+	/**
+	 * Sends a log entry to the configured PSR-3 LoggerInterface
+	 *
+	 * @param string $message
+	 * @param int    $level
+	 */
+	public function log($message, $level)
+	{
+		Injector::inst()->get(LoggerInterface::class)->log($level, $message);
+	}
+
+	/**
+	 * Set the HTTP status code that should be returned when there's an error.
+	 *
+	 * @param int $errorCode
+	 */
+	public function setErrorCode($errorCode)
+	{
+		$this->errorCode = $errorCode;
+	}
+
+	/**
+	 * @deprecated
+	 * @param string $from
+	 */
+	public static function set_from_email_address($from)
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		static::config()->set('from_email_address', $from);
+	}
+
+	/**
+	 * @deprecated
+	 * @return null|string
+	 */
+	public static function get_from_email_address()
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		return static::config()->get('from_email_address');
+	}
+
+	/**
+	 * @deprecated
+	 * @param string $to
+	 */
+	public static function set_to_email_address($to)
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		static::config()->set('to_email_address', $to);
+	}
+
+	/**
+	 * @deprecated
+	 * @return null|string
+	 */
+	public static function get_to_email_address()
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		return static::config()->get('to_email_address');
+	}
+
+	/**
+	 * @deprecated
+	 * @param bool $results
+	 */
+	public static function set_email_results($results)
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		static::config()->set('email_results', $results);
+	}
+
+	/**
+	 * @deprecated
+	 * @return bool
+	 */
+	public static function get_email_results()
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		return static::config()->get('email_results');
+	}
 }