silverstripe / silverstripe-environmentcheck

src/Checks/CacheHeadersCheck.php

Indentation +184 added lines, -184 removed lines

@@ -20,188 +20,188 @@
  */
 class CacheHeadersCheck implements EnvironmentCheck
 {
-    use Fetcher;
-
-    /**
-     * Settings that must be included in the Cache-Control header
-     *
-     * @var array
-     */
-    protected $mustInclude = [];
-
-    /**
-     * Settings that must be excluded in the Cache-Control header
-     *
-     * @var array
-     */
-    protected $mustExclude = [];
-
-    /**
-     * Result to keep track of status and messages for all checks, reuses
-     * ValidationResult for convenience.
-     *
-     * @var ValidationResult
-     */
-    protected $result;
-
-    /**
-     * Set up with URL, arrays of header settings to check.
-     *
-     * @param string $url
-     * @param array $mustInclude Settings that must be included in Cache-Control
-     * @param array $mustExclude Settings that must be excluded in Cache-Control
-     */
-    public function __construct($url = '', $mustInclude = [], $mustExclude = [])
-    {
-        $this->setURL($url);
-        $this->mustInclude = $mustInclude;
-        $this->mustExclude = $mustExclude;
-    }
-
-    /**
-     * Check that correct caching headers are present.
-     *
-     * @return void
-     */
-    public function check()
-    {
-        // Using a validation result to capture messages
-        $this->result = new ValidationResult();
-
-        $response = $this->client->get($this->getURL());
-        $fullURL = $this->getURL();
-        if ($response === null) {
-            return [
-                EnvironmentCheck::ERROR,
-                "Cache headers check request failed for $fullURL",
-            ];
-        }
-
-        //Check that Etag exists
-        $this->checkEtag($response);
-
-        // Check Cache-Control settings
-        $this->checkCacheControl($response);
-
-        if ($this->result->isValid()) {
-            return [
-                EnvironmentCheck::OK,
-                $this->getMessage(),
-            ];
-        } else {
-            // @todo Ability to return a warning
-            return [
-                EnvironmentCheck::ERROR,
-                $this->getMessage(),
-            ];
-        }
-    }
-
-    /**
-     * Collate messages from ValidationResult so that it is clear which parts
-     * of the check passed and which failed.
-     *
-     * @return string
-     */
-    private function getMessage()
-    {
-        $ret = '';
-        // Filter good messages
-        $goodTypes = [ValidationResult::TYPE_GOOD, ValidationResult::TYPE_INFO];
-        $good = array_filter(
-            $this->result->getMessages(),
-            function ($val, $key) use ($goodTypes) {
-                if (in_array($val['messageType'], $goodTypes)) {
-                    return true;
-                }
-                return false;
-            },
-            ARRAY_FILTER_USE_BOTH
-        );
-        if (!empty($good)) {
-            $ret .= "GOOD: " . implode('; ', array_column($good, 'message')) . " ";
-        }
-
-        // Filter bad messages
-        $badTypes = [ValidationResult::TYPE_ERROR, ValidationResult::TYPE_WARNING];
-        $bad = array_filter(
-            $this->result->getMessages(),
-            function ($val, $key) use ($badTypes) {
-                if (in_array($val['messageType'], $badTypes)) {
-                    return true;
-                }
-                return false;
-            },
-            ARRAY_FILTER_USE_BOTH
-        );
-        if (!empty($bad)) {
-            $ret .= "BAD: " . implode('; ', array_column($bad, 'message'));
-        }
-        return $ret;
-    }
-
-    /**
-     * Check that ETag header exists
-     *
-     * @param ResponseInterface $response
-     * @return void
-     */
-    private function checkEtag(ResponseInterface $response)
-    {
-        $eTag = $response->getHeaderLine('ETag');
-        $fullURL = Controller::join_links(Director::absoluteBaseURL(), $this->url);
-
-        if ($eTag) {
-            $this->result->addMessage(
-                "$fullURL includes an Etag header in response",
-                ValidationResult::TYPE_GOOD
-            );
-            return;
-        }
-        $this->result->addError(
-            "$fullURL is missing an Etag header",
-            ValidationResult::TYPE_WARNING
-        );
-    }
-
-    /**
-     * Check that the correct header settings are either included or excluded.
-     *
-     * @param ResponseInterface $response
-     * @return void
-     */
-    private function checkCacheControl(ResponseInterface $response)
-    {
-        $cacheControl = $response->getHeaderLine('Cache-Control');
-        $vals = array_map('trim', explode(',', $cacheControl));
-        $fullURL = Controller::join_links(Director::absoluteBaseURL(), $this->url);
-
-        // All entries from must contain should be present
-        if ($this->mustInclude == array_intersect($this->mustInclude, $vals)) {
-            $matched = implode(",", $this->mustInclude);
-            $this->result->addMessage(
-                "$fullURL includes all settings: {$matched}",
-                ValidationResult::TYPE_GOOD
-            );
-        } else {
-            $missing = implode(",", array_diff($this->mustInclude, $vals));
-            $this->result->addError(
-                "$fullURL is excluding some settings: {$missing}"
-            );
-        }
-
-        // All entries from must exclude should not be present
-        if (empty(array_intersect($this->mustExclude, $vals))) {
-            $missing = implode(",", $this->mustExclude);
-            $this->result->addMessage(
-                "$fullURL excludes all settings: {$missing}",
-                ValidationResult::TYPE_GOOD
-            );
-        } else {
-            $matched = implode(",", array_intersect($this->mustExclude, $vals));
-            $this->result->addError(
-                "$fullURL is including some settings: {$matched}"
-            );
-        }
-    }
+	use Fetcher;
+
+	/**
+	 * Settings that must be included in the Cache-Control header
+	 *
+	 * @var array
+	 */
+	protected $mustInclude = [];
+
+	/**
+	 * Settings that must be excluded in the Cache-Control header
+	 *
+	 * @var array
+	 */
+	protected $mustExclude = [];
+
+	/**
+	 * Result to keep track of status and messages for all checks, reuses
+	 * ValidationResult for convenience.
+	 *
+	 * @var ValidationResult
+	 */
+	protected $result;
+
+	/**
+	 * Set up with URL, arrays of header settings to check.
+	 *
+	 * @param string $url
+	 * @param array $mustInclude Settings that must be included in Cache-Control
+	 * @param array $mustExclude Settings that must be excluded in Cache-Control
+	 */
+	public function __construct($url = '', $mustInclude = [], $mustExclude = [])
+	{
+		$this->setURL($url);
+		$this->mustInclude = $mustInclude;
+		$this->mustExclude = $mustExclude;
+	}
+
+	/**
+	 * Check that correct caching headers are present.
+	 *
+	 * @return void
+	 */
+	public function check()
+	{
+		// Using a validation result to capture messages
+		$this->result = new ValidationResult();
+
+		$response = $this->client->get($this->getURL());
+		$fullURL = $this->getURL();
+		if ($response === null) {
+			return [
+				EnvironmentCheck::ERROR,
+				"Cache headers check request failed for $fullURL",
+			];
+		}
+
+		//Check that Etag exists
+		$this->checkEtag($response);
+
+		// Check Cache-Control settings
+		$this->checkCacheControl($response);
+
+		if ($this->result->isValid()) {
+			return [
+				EnvironmentCheck::OK,
+				$this->getMessage(),
+			];
+		} else {
+			// @todo Ability to return a warning
+			return [
+				EnvironmentCheck::ERROR,
+				$this->getMessage(),
+			];
+		}
+	}
+
+	/**
+	 * Collate messages from ValidationResult so that it is clear which parts
+	 * of the check passed and which failed.
+	 *
+	 * @return string
+	 */
+	private function getMessage()
+	{
+		$ret = '';
+		// Filter good messages
+		$goodTypes = [ValidationResult::TYPE_GOOD, ValidationResult::TYPE_INFO];
+		$good = array_filter(
+			$this->result->getMessages(),
+			function ($val, $key) use ($goodTypes) {
+				if (in_array($val['messageType'], $goodTypes)) {
+					return true;
+				}
+				return false;
+			},
+			ARRAY_FILTER_USE_BOTH
+		);
+		if (!empty($good)) {
+			$ret .= "GOOD: " . implode('; ', array_column($good, 'message')) . " ";
+		}
+
+		// Filter bad messages
+		$badTypes = [ValidationResult::TYPE_ERROR, ValidationResult::TYPE_WARNING];
+		$bad = array_filter(
+			$this->result->getMessages(),
+			function ($val, $key) use ($badTypes) {
+				if (in_array($val['messageType'], $badTypes)) {
+					return true;
+				}
+				return false;
+			},
+			ARRAY_FILTER_USE_BOTH
+		);
+		if (!empty($bad)) {
+			$ret .= "BAD: " . implode('; ', array_column($bad, 'message'));
+		}
+		return $ret;
+	}
+
+	/**
+	 * Check that ETag header exists
+	 *
+	 * @param ResponseInterface $response
+	 * @return void
+	 */
+	private function checkEtag(ResponseInterface $response)
+	{
+		$eTag = $response->getHeaderLine('ETag');
+		$fullURL = Controller::join_links(Director::absoluteBaseURL(), $this->url);
+
+		if ($eTag) {
+			$this->result->addMessage(
+				"$fullURL includes an Etag header in response",
+				ValidationResult::TYPE_GOOD
+			);
+			return;
+		}
+		$this->result->addError(
+			"$fullURL is missing an Etag header",
+			ValidationResult::TYPE_WARNING
+		);
+	}
+
+	/**
+	 * Check that the correct header settings are either included or excluded.
+	 *
+	 * @param ResponseInterface $response
+	 * @return void
+	 */
+	private function checkCacheControl(ResponseInterface $response)
+	{
+		$cacheControl = $response->getHeaderLine('Cache-Control');
+		$vals = array_map('trim', explode(',', $cacheControl));
+		$fullURL = Controller::join_links(Director::absoluteBaseURL(), $this->url);
+
+		// All entries from must contain should be present
+		if ($this->mustInclude == array_intersect($this->mustInclude, $vals)) {
+			$matched = implode(",", $this->mustInclude);
+			$this->result->addMessage(
+				"$fullURL includes all settings: {$matched}",
+				ValidationResult::TYPE_GOOD
+			);
+		} else {
+			$missing = implode(",", array_diff($this->mustInclude, $vals));
+			$this->result->addError(
+				"$fullURL is excluding some settings: {$missing}"
+			);
+		}
+
+		// All entries from must exclude should not be present
+		if (empty(array_intersect($this->mustExclude, $vals))) {
+			$missing = implode(",", $this->mustExclude);
+			$this->result->addMessage(
+				"$fullURL excludes all settings: {$missing}",
+				ValidationResult::TYPE_GOOD
+			);
+		} else {
+			$matched = implode(",", array_intersect($this->mustExclude, $vals));
+			$this->result->addError(
+				"$fullURL is including some settings: {$matched}"
+			);
+		}
+	}
 }

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/EnvironmentCheckSuite.php

Indentation +180 added lines, -180 removed lines

@@ -32,184 +32,184 @@
  */
 class EnvironmentCheckSuite
 {
-    use Configurable;
-    use Injectable;
-    use Extensible;
-    /**
-     * Name of this suite.
-     *
-     * @var string
-     */
-    protected $name;
-
-    /**
-     * @var array
-     */
-    protected $checks = [];
-
-    /**
-     * Associative array of named checks registered via the config system. Each check should specify:
-     * - definition (e.g. 'MyHealthCheck("my param")')
-     * - title (e.g. 'Is my feature working?')
-     * - state (setting this to 'disabled' will cause suites to skip this check entirely.
-     *
-     * @var array
-     */
-    private static $registered_checks = [];
-
-    /**
-     * Associative array of named suites registered via the config system. Each suite should enumerate
-     * named checks that have been configured in 'registered_checks'.
-     *
-     * @var array
-     */
-    private static $registered_suites = [];
-
-    /**
-     * Load checks for this suite from the configuration system. This is an alternative to the
-     * EnvironmentCheckSuite::register - both can be used, checks will be appended to the suite.
-     *
-     * @param string $suiteName The name of this suite.
-     */
-    public function __construct($suiteName)
-    {
-        if (empty($this->config()->registered_suites[$suiteName])) {
-            // Not registered via config system, but it still may be configured later via self::register.
-            return;
-        }
-
-        foreach ($this->config()->registered_suites[$suiteName] as $checkName) {
-            if (empty($this->config()->registered_checks[$checkName])) {
-                throw new InvalidArgumentException(
-                    "Bad EnvironmentCheck: '$checkName' - the named check has not been registered."
-                );
-            }
-
-            $check = $this->config()->registered_checks[$checkName];
-
-            // Existing named checks can be disabled by setting their 'state' to 'disabled'.
-            // This is handy for disabling checks mandated by modules.
-            if (!empty($check['state']) && $check['state'] === 'disabled') {
-                continue;
-            }
-
-            // Add the check to this suite.
-            $this->push($check['definition'], $check['title']);
-        }
-    }
-
-    /**
-     * Run this test suite and return the result code of the worst result.
-     *
-     * @return EnvironmentCheckSuiteResult
-     */
-    public function run()
-    {
-        $result = new EnvironmentCheckSuiteResult();
-
-        foreach ($this->checkInstances() as $check) {
-            list($checkClass, $checkTitle) = $check;
-            try {
-                list($status, $message) = $checkClass->check();
-            // If the check fails, register that as an error
-            } catch (Exception $e) {
-                $status = EnvironmentCheck::ERROR;
-                $message = $e->getMessage();
-            }
-            $result->addResult($status, $message, $checkTitle);
-        }
-
-        return $result;
-    }
-
-    /**
-     * Get instances of all the environment checks.
-     *
-     * @return EnvironmentChecker[]
-     * @throws InvalidArgumentException
-     */
-    protected function checkInstances()
-    {
-        $output = [];
-        foreach ($this->checks as $check) {
-            list($checkClass, $checkTitle) = $check;
-            if (is_string($checkClass)) {
-                $checkInst = Injector::inst()->create($checkClass);
-                if ($checkInst instanceof EnvironmentCheck) {
-                    $output[] = [$checkInst, $checkTitle];
-                } else {
-                    throw new InvalidArgumentException(
-                        "Bad EnvironmentCheck: '$checkClass' - the named class doesn't implement EnvironmentCheck"
-                    );
-                }
-            } elseif ($checkClass instanceof EnvironmentCheck) {
-                $output[] = [$checkClass, $checkTitle];
-            } else {
-                throw new InvalidArgumentException("Bad EnvironmentCheck: " . var_export($check, true));
-            }
-        }
-        return $output;
-    }
-
-    /**
-     * Add a check to this suite.
-     *
-     * @param mixed $check
-     * @param string $title
-     */
-    public function push($check, $title = null)
-    {
-        if (!$title) {
-            $title = is_string($check) ? $check : get_class($check);
-        }
-        $this->checks[] = [$check, $title];
-    }
-
-    /////////////////////////////////////////////////////////////////////////////////////////////
-
-    /**
-     * @var array
-     */
-    protected static $instances = [];
-
-    /**
-     * Return a named instance of EnvironmentCheckSuite.
-     *
-     * @param string $name
-     *
-     * @return EnvironmentCheckSuite
-     */
-    public static function inst($name)
-    {
-        if (!isset(self::$instances[$name])) {
-            self::$instances[$name] = new EnvironmentCheckSuite($name);
-        }
-        return self::$instances[$name];
-    }
-
-    /**
-     * Register a check against the named check suite.
-     *
-     * @param string|array $names
-     * @param EnvironmentCheck $check
-     * @param string|array
-     */
-    public static function register($names, $check, $title = null)
-    {
-        if (!is_array($names)) {
-            $names = [$names];
-        }
-
-        foreach ($names as $name) {
-            self::inst($name)->push($check, $title);
-        }
-    }
-
-    /**
-     * Unregisters all checks.
-     */
-    public static function reset()
-    {
-        self::$instances = [];
-    }
+	use Configurable;
+	use Injectable;
+	use Extensible;
+	/**
+	 * Name of this suite.
+	 *
+	 * @var string
+	 */
+	protected $name;
+
+	/**
+	 * @var array
+	 */
+	protected $checks = [];
+
+	/**
+	 * Associative array of named checks registered via the config system. Each check should specify:
+	 * - definition (e.g. 'MyHealthCheck("my param")')
+	 * - title (e.g. 'Is my feature working?')
+	 * - state (setting this to 'disabled' will cause suites to skip this check entirely.
+	 *
+	 * @var array
+	 */
+	private static $registered_checks = [];
+
+	/**
+	 * Associative array of named suites registered via the config system. Each suite should enumerate
+	 * named checks that have been configured in 'registered_checks'.
+	 *
+	 * @var array
+	 */
+	private static $registered_suites = [];
+
+	/**
+	 * Load checks for this suite from the configuration system. This is an alternative to the
+	 * EnvironmentCheckSuite::register - both can be used, checks will be appended to the suite.
+	 *
+	 * @param string $suiteName The name of this suite.
+	 */
+	public function __construct($suiteName)
+	{
+		if (empty($this->config()->registered_suites[$suiteName])) {
+			// Not registered via config system, but it still may be configured later via self::register.
+			return;
+		}
+
+		foreach ($this->config()->registered_suites[$suiteName] as $checkName) {
+			if (empty($this->config()->registered_checks[$checkName])) {
+				throw new InvalidArgumentException(
+					"Bad EnvironmentCheck: '$checkName' - the named check has not been registered."
+				);
+			}
+
+			$check = $this->config()->registered_checks[$checkName];
+
+			// Existing named checks can be disabled by setting their 'state' to 'disabled'.
+			// This is handy for disabling checks mandated by modules.
+			if (!empty($check['state']) && $check['state'] === 'disabled') {
+				continue;
+			}
+
+			// Add the check to this suite.
+			$this->push($check['definition'], $check['title']);
+		}
+	}
+
+	/**
+	 * Run this test suite and return the result code of the worst result.
+	 *
+	 * @return EnvironmentCheckSuiteResult
+	 */
+	public function run()
+	{
+		$result = new EnvironmentCheckSuiteResult();
+
+		foreach ($this->checkInstances() as $check) {
+			list($checkClass, $checkTitle) = $check;
+			try {
+				list($status, $message) = $checkClass->check();
+			// If the check fails, register that as an error
+			} catch (Exception $e) {
+				$status = EnvironmentCheck::ERROR;
+				$message = $e->getMessage();
+			}
+			$result->addResult($status, $message, $checkTitle);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Get instances of all the environment checks.
+	 *
+	 * @return EnvironmentChecker[]
+	 * @throws InvalidArgumentException
+	 */
+	protected function checkInstances()
+	{
+		$output = [];
+		foreach ($this->checks as $check) {
+			list($checkClass, $checkTitle) = $check;
+			if (is_string($checkClass)) {
+				$checkInst = Injector::inst()->create($checkClass);
+				if ($checkInst instanceof EnvironmentCheck) {
+					$output[] = [$checkInst, $checkTitle];
+				} else {
+					throw new InvalidArgumentException(
+						"Bad EnvironmentCheck: '$checkClass' - the named class doesn't implement EnvironmentCheck"
+					);
+				}
+			} elseif ($checkClass instanceof EnvironmentCheck) {
+				$output[] = [$checkClass, $checkTitle];
+			} else {
+				throw new InvalidArgumentException("Bad EnvironmentCheck: " . var_export($check, true));
+			}
+		}
+		return $output;
+	}
+
+	/**
+	 * Add a check to this suite.
+	 *
+	 * @param mixed $check
+	 * @param string $title
+	 */
+	public function push($check, $title = null)
+	{
+		if (!$title) {
+			$title = is_string($check) ? $check : get_class($check);
+		}
+		$this->checks[] = [$check, $title];
+	}
+
+	/////////////////////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * @var array
+	 */
+	protected static $instances = [];
+
+	/**
+	 * Return a named instance of EnvironmentCheckSuite.
+	 *
+	 * @param string $name
+	 *
+	 * @return EnvironmentCheckSuite
+	 */
+	public static function inst($name)
+	{
+		if (!isset(self::$instances[$name])) {
+			self::$instances[$name] = new EnvironmentCheckSuite($name);
+		}
+		return self::$instances[$name];
+	}
+
+	/**
+	 * Register a check against the named check suite.
+	 *
+	 * @param string|array $names
+	 * @param EnvironmentCheck $check
+	 * @param string|array
+	 */
+	public static function register($names, $check, $title = null)
+	{
+		if (!is_array($names)) {
+			$names = [$names];
+		}
+
+		foreach ($names as $name) {
+			self::inst($name)->push($check, $title);
+		}
+	}
+
+	/**
+	 * Unregisters all checks.
+	 */
+	public static function reset()
+	{
+		self::$instances = [];
+	}
 }

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');
+	}
 }

src/Checks/SessionCheck.php

Indentation +49 added lines, -49 removed lines

@@ -14,58 +14,58 @@
  */
 class SessionCheck implements EnvironmentCheck
 {
-    use Fetcher;
+	use Fetcher;
 
-    /**
-     * Set up check with URL
-     *
-     * @param string $url The route, excluding the domain
-     * @inheritdoc
-     */
-    public function __construct($url = '')
-    {
-        $this->setURL($url);
-    }
+	/**
+	 * Set up check with URL
+	 *
+	 * @param string $url The route, excluding the domain
+	 * @inheritdoc
+	 */
+	public function __construct($url = '')
+	{
+		$this->setURL($url);
+	}
 
-    /**
-     * Check that the response for URL does not create a session
-     *
-     * @return array
-     */
-    public function check()
-    {
-        $response = $this->client->get($this->getURL());
-        $cookie = $this->getCookie($response);
-        $fullURL = $this->getURL();
+	/**
+	 * Check that the response for URL does not create a session
+	 *
+	 * @return array
+	 */
+	public function check()
+	{
+		$response = $this->client->get($this->getURL());
+		$cookie = $this->getCookie($response);
+		$fullURL = $this->getURL();
 
-        if ($cookie) {
-            return [
-                EnvironmentCheck::ERROR,
-                "Sessions are being set for {$fullURL} : Set-Cookie => " . $cookie,
-            ];
-        }
-        return [
-            EnvironmentCheck::OK,
-            "Sessions are not being created for {$fullURL}