silverstripe / silverstripe-environmentcheck

src/EnvironmentCheckSuite.php

Unused Use Statements -3 removed lines

@@ -9,9 +9,6 @@
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\EnvironmentCheck\EnvironmentCheck;
-use SilverStripe\ORM\ArrayList;
-use SilverStripe\View\ArrayData;
-use SilverStripe\View\ViewableData;
 
 /**
  * Represents a suite of environment checks.

Indentation +181 added lines, -181 removed lines

@@ -36,185 +36,185 @@
  */
 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)
-    {
-        $this->constructExtensions();
-        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 int
-     */
-    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 array
-     * @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)
+	{
+		$this->constructExtensions();
+		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 int
+	 */
+	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 array
+	 * @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/DevHealthController.php

Indentation +18 added lines, -18 removed lines

@@ -12,25 +12,25 @@
  */
 class DevHealthController extends Controller
 {
-    /**
-     * @var array
-     */
-    private static $allowed_actions = [
-        'index'
-    ];
+	/**
+	 * @var array
+	 */
+	private static $allowed_actions = [
+		'index'
+	];
 
-    /**
-     * @return EnvironmentChecker
-     *
-     * @throws HTTPResponse_Exception
-     */
-    public function index()
-    {
-        // health check does not require permission to run
+	/**
+	 * @return EnvironmentChecker
+	 *
+	 * @throws HTTPResponse_Exception
+	 */
+	public function index()
+	{
+		// health check does not require permission to run
 
-        $checker = new EnvironmentChecker('health', 'Site health');
-        $checker->setErrorCode(500);
+		$checker = new EnvironmentChecker('health', 'Site health');
+		$checker->setErrorCode(500);
 
-        return $checker;
-    }
+		return $checker;
+	}
 }

src/Controllers/DevCheckController.php

Indentation +34 added lines, -34 removed lines

@@ -12,38 +12,38 @@
  */
 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->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->init($this->config()->permission);
+
+		return $checker;
+	}
 }

src/EnvironmentChecker.php

Indentation +287 added lines, -287 removed lines

@@ -25,291 +25,291 @@
  */
 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 (getenv('ENVCHECK_BASICAUTH_USERNAME') && getenv('ENVCHECK_BASICAUTH_PASSWORD')) {
-            if (isset($_SERVER['PHP_AUTH_USER']) && isset($_SERVER['PHP_AUTH_PW'])) {
-                // authenticate the input user/pass with the configured credentials
-                if (!(
-                        $_SERVER['PHP_AUTH_USER'] == getenv('ENVCHECK_BASICAUTH_USERNAME')
-                        && $_SERVER['PHP_AUTH_PW'] == getenv('ENVCHECK_BASICAUTH_PASSWORD')
-                    )
-                ) {
-                    $response = new HTTPResponse(null, 401);
-                    $response->addHeader('WWW-Authenticate', "Basic realm=\"Environment check\"");
-                    // Exception is caught by RequestHandler->handleRequest() and will halt further execution
-                    $e = new HTTPResponse_Exception(null, 401);
-                    $e->setResponse($response);
-                    throw $e;
-                }
-            } else {
-                $response = new HTTPResponse(null, 401);
-                $response->addHeader('WWW-Authenticate', "Basic realm=\"Environment check\"");
-                // Exception is caught by RequestHandler->handleRequest() and will halt further execution
-                $e = new HTTPResponse_Exception(null, 401);
-                $e->setResponse($response);
-                throw $e;
-            }
-        } else {
-            if (!$this->canAccess(null, $permission)) {
-                return $this->httpError(403);
-            }
-        }
-    }
-
-    /**
-     * @param null|int|Member $member
-     * @param string $permission
-     *
-     * @return bool
-     *
-     * @throws HTTPResponse_Exception
-     */
-    public function canAccess($member = null, $permission = 'ADMIN')
-    {
-        if (!$member) {
-            $member = Member::currentUser();
-        }
-
-        if (!$member) {
-            $member = BasicAuth::requireLogin('Environment Checker', $permission, false);
-        }
-
-        // 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()->email_results && !$result->ShouldPass()) {
-            $email = new Email(
-                $this->config()->from_email_address,
-                $this->config()->to_email_address,
-                $this->title,
-                $resultText
-            );
-            $email->send();
-        }
-
-        // Optionally log errors and warnings individually
-        foreach ($result->Details() as $detail) {
-            if ($this->config()->log_results_warning && $detail->StatusCode == EnvironmentCheck::WARNING) {
-                $this->log(
-                    sprintf('EnvironmentChecker warning at "%s" check. Message: %s', $detail->Check, $detail->Message),
-                    $this->config()->log_results_warning_level
-                );
-            } elseif ($this->config()->log_results_error && $detail->StatusCode == EnvironmentCheck::ERROR) {
-                $this->log(
-                    sprintf('EnvironmentChecker error at "%s" check. Message: %s', $detail->Check, $detail->Message),
-                    $this->config()->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');
-        Config::modify()->set(__CLASS__, 'from_email_address', $from);
-    }
-
-    /**
-     * @deprecated
-     * @return null|string
-     */
-    public static function get_from_email_address()
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        return Config::inst()->get(__CLASS__, 'from_email_address');
-    }
-
-    /**
-     * @deprecated
-     * @param string $to
-     */
-    public static function set_to_email_address($to)
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        Config::modify()->set(__CLASS__, 'to_email_address',  $to);
-    }
-
-    /**
-     * @deprecated
-     * @return null|string
-     */
-    public static function get_to_email_address()
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        return Config::inst()->get(__CLASS__, 'to_email_address');
-    }
-
-    /**
-     * @deprecated
-     * @param bool $results
-     */
-    public static function set_email_results($results)
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        Config::modify()->set(__CLASS__, 'email_results', $results);
-    }
-
-    /**
-     * @deprecated
-     * @return bool
-     */
-    public static function get_email_results()
-    {
-        Deprecation::notice('2.0', 'Use config API instead');
-        return Config::inst()->get(__CLASS__, '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 (getenv('ENVCHECK_BASICAUTH_USERNAME') && getenv('ENVCHECK_BASICAUTH_PASSWORD')) {
+			if (isset($_SERVER['PHP_AUTH_USER']) && isset($_SERVER['PHP_AUTH_PW'])) {
+				// authenticate the input user/pass with the configured credentials
+				if (!(
+						$_SERVER['PHP_AUTH_USER'] == getenv('ENVCHECK_BASICAUTH_USERNAME')
+						&& $_SERVER['PHP_AUTH_PW'] == getenv('ENVCHECK_BASICAUTH_PASSWORD')
+					)
+				) {
+					$response = new HTTPResponse(null, 401);
+					$response->addHeader('WWW-Authenticate', "Basic realm=\"Environment check\"");
+					// Exception is caught by RequestHandler->handleRequest() and will halt further execution
+					$e = new HTTPResponse_Exception(null, 401);
+					$e->setResponse($response);
+					throw $e;
+				}
+			} else {
+				$response = new HTTPResponse(null, 401);
+				$response->addHeader('WWW-Authenticate', "Basic realm=\"Environment check\"");
+				// Exception is caught by RequestHandler->handleRequest() and will halt further execution
+				$e = new HTTPResponse_Exception(null, 401);
+				$e->setResponse($response);
+				throw $e;
+			}
+		} else {
+			if (!$this->canAccess(null, $permission)) {
+				return $this->httpError(403);
+			}
+		}
+	}
+
+	/**
+	 * @param null|int|Member $member
+	 * @param string $permission
+	 *
+	 * @return bool
+	 *
+	 * @throws HTTPResponse_Exception
+	 */
+	public function canAccess($member = null, $permission = 'ADMIN')
+	{
+		if (!$member) {
+			$member = Member::currentUser();
+		}
+
+		if (!$member) {
+			$member = BasicAuth::requireLogin('Environment Checker', $permission, false);
+		}
+
+		// 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()->email_results && !$result->ShouldPass()) {
+			$email = new Email(
+				$this->config()->from_email_address,
+				$this->config()->to_email_address,
+				$this->title,
+				$resultText
+			);
+			$email->send();
+		}
+
+		// Optionally log errors and warnings individually
+		foreach ($result->Details() as $detail) {
+			if ($this->config()->log_results_warning && $detail->StatusCode == EnvironmentCheck::WARNING) {
+				$this->log(
+					sprintf('EnvironmentChecker warning at "%s" check. Message: %s', $detail->Check, $detail->Message),
+					$this->config()->log_results_warning_level
+				);
+			} elseif ($this->config()->log_results_error && $detail->StatusCode == EnvironmentCheck::ERROR) {
+				$this->log(
+					sprintf('EnvironmentChecker error at "%s" check. Message: %s', $detail->Check, $detail->Message),
+					$this->config()->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');
+		Config::modify()->set(__CLASS__, 'from_email_address', $from);
+	}
+
+	/**
+	 * @deprecated
+	 * @return null|string
+	 */
+	public static function get_from_email_address()
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		return Config::inst()->get(__CLASS__, 'from_email_address');
+	}
+
+	/**
+	 * @deprecated
+	 * @param string $to
+	 */
+	public static function set_to_email_address($to)
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		Config::modify()->set(__CLASS__, 'to_email_address',  $to);
+	}
+
+	/**
+	 * @deprecated
+	 * @return null|string
+	 */
+	public static function get_to_email_address()
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		return Config::inst()->get(__CLASS__, 'to_email_address');
+	}
+
+	/**
+	 * @deprecated
+	 * @param bool $results
+	 */
+	public static function set_email_results($results)
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		Config::modify()->set(__CLASS__, 'email_results', $results);
+	}
+
+	/**
+	 * @deprecated
+	 * @return bool
+	 */
+	public static function get_email_results()
+	{
+		Deprecation::notice('2.0', 'Use config API instead');
+		return Config::inst()->get(__CLASS__, 'email_results');
+	}
 }

src/EnvironmentCheckSuiteResult.php

Indentation +99 added lines, -99 removed lines

@@ -14,112 +14,112 @@
  */
 class EnvironmentCheckSuiteResult extends ViewableData
 {
-    /**
-     * @var ArrayList
-     */
-    protected $details;
+	/**
+	 * @var ArrayList
+	 */
+	protected $details;
 
-    /**
-     * @var int
-     */
-    protected $worst = 0;
+	/**
+	 * @var int
+	 */
+	protected $worst = 0;
 
-    public function __construct()
-    {
-        parent::__construct();
-        $this->details = new ArrayList();
-    }
+	public function __construct()
+	{
+		parent::__construct();
+		$this->details = new ArrayList();
+	}
 
-    /**
-     * @param int $status
-     * @param string $message
-     * @param string $checkIdentifier
-     */
-    public function addResult($status, $message, $checkIdentifier)
-    {
-        $this->details->push(new ArrayData([
-            'Check' => $checkIdentifier,
-            'Status' => $this->statusText($status),
-            'StatusCode' => $status,
-            'Message' => $message,
-        ]));
+	/**
+	 * @param int $status
+	 * @param string $message
+	 * @param string $checkIdentifier
+	 */
+	public function addResult($status, $message, $checkIdentifier)
+	{
+		$this->details->push(new ArrayData([
+			'Check' => $checkIdentifier,
+			'Status' => $this->statusText($status),
+			'StatusCode' => $status,
+			'Message' => $message,
+		]));
 
-        $this->worst = max($this->worst, $status);
-    }
+		$this->worst = max($this->worst, $status);
+	}
 
-    /**
-     * Returns true if there are no errors.
-     *
-     * @return bool
-     */
-    public function ShouldPass()
-    {
-        return $this->worst <= EnvironmentCheck::WARNING;
-    }
+	/**
+	 * Returns true if there are no errors.
+	 *
+	 * @return bool
+	 */
+	public function ShouldPass()
+	{
+		return $this->worst <= EnvironmentCheck::WARNING;
+	}
 
-    /**
-     * Returns overall (i.e. worst) status as a string.
-     *
-     * @return string
-     */
-    public function Status()
-    {
-        return $this->statusText($this->worst);
-    }
+	/**
+	 * Returns overall (i.e. worst) status as a string.
+	 *
+	 * @return string
+	 */
+	public function Status()
+	{
+		return $this->statusText($this->worst);
+	}
 
-    /**
-     * Returns detailed status information about each check.
-     *
-     * @return ArrayList
-     */
-    public function Details()
-    {
-        return $this->details;
-    }
+	/**
+	 * Returns detailed status information about each check.
+	 *
+	 * @return ArrayList
+	 */
+	public function Details()
+	{
+		return $this->details;
+	}
 
-    /**
-     * Convert the final result status and details to JSON.
-     *
-     * @return string
-     */
-    public function toJSON()
-    {
-        $result = [
-            'Status' => $this->Status(),
-            'ShouldPass' => $this->ShouldPass(),
-            'Checks' => []
-        ];
-        foreach ($this->details as $detail) {
-            $result['Checks'][] = $detail->toMap();
-        }
-        return json_encode($result);
-    }
+	/**
+	 * Convert the final result status and details to JSON.
+	 *
+	 * @return string
+	 */
+	public function toJSON()
+	{
+		$result = [
+			'Status' => $this->Status(),
+			'ShouldPass' => $this->ShouldPass(),
+			'Checks' => []
+		];
+		foreach ($this->details as $detail) {
+			$result['Checks'][] = $detail->toMap();
+		}
+		return json_encode($result);
+	}
 
-    /**
-     * Return a text version of a status code.
-     *
-     * @param  int $status
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    protected function statusText($status)
-    {
-        switch ($status) {
-            case EnvironmentCheck::ERROR:
-                return 'ERROR';
-                break;
-            case EnvironmentCheck::WARNING:
-                return 'WARNING';
-                break;
-            case EnvironmentCheck::OK:
-                return 'OK';
-                break;
-            case 0:
-                return 'NO CHECKS';
-                break;
-            default:
-                throw new InvalidArgumentException("Bad environment check status '$status'");
-                break;
-        }
-    }
+	/**
+	 * Return a text version of a status code.
+	 *
+	 * @param  int $status
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	protected function statusText($status)
+	{
+		switch ($status) {
+			case EnvironmentCheck::ERROR:
+				return 'ERROR';
+				break;
+			case EnvironmentCheck::WARNING:
+				return 'WARNING';
+				break;
+			case EnvironmentCheck::OK:
+				return 'OK';
+				break;
+			case 0:
+				return 'NO CHECKS';
+				break;
+			default:
+				throw new InvalidArgumentException("Bad environment check status '$status'");
+				break;
+		}
+	}
 }

src/Checks/SolrIndexCheck.php

Indentation +43 added lines, -43 removed lines

@@ -13,53 +13,53 @@
  */
 class SolrIndexCheck implements EnvironmentCheck
 {
-    /**
-     * @var null|string
-     */
-    protected $indexClass;
+	/**
+	 * @var null|string
+	 */
+	protected $indexClass;
 
-    /**
-     * @param string $indexClass Limit the index checks to the specified class and all its subclasses.
-     */
-    public function __construct($indexClass = null)
-    {
-        $this->indexClass = $indexClass;
-    }
+	/**
+	 * @param string $indexClass Limit the index checks to the specified class and all its subclasses.
+	 */
+	public function __construct($indexClass = null)
+	{
+		$this->indexClass = $indexClass;
+	}
 
-    /**
-     * {@inheritDoc}
-     *
-     * @return array
-     */
-    public function check()
-    {
-        $brokenCores = [];
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @return array
+	 */
+	public function check()
+	{
+		$brokenCores = [];
 
-        /**
-         * @todo Revisit this when silverstripe/fulltextsearch has 4.x compat
-         */
-        if (!class_exists('\\Solr')) {
-            return [
-                EnvironmentCheck::ERROR,
-                'Class `Solr` not found. Is the fulltextsearch module installed?'
-            ];
-        }
+		/**
+		 * @todo Revisit this when silverstripe/fulltextsearch has 4.x compat
+		 */
+		if (!class_exists('\\Solr')) {
+			return [
+				EnvironmentCheck::ERROR,
+				'Class `Solr` not found. Is the fulltextsearch module installed?'
+			];
+		}
 
-        $service = \Solr::service();
-        foreach (\Solr::get_indexes($this->indexClass) as $index) {
-            $core = $index->getIndexName();
-            if (!$service->coreIsActive($core)) {
-                $brokenCores[] = $core;
-            }
-        }
+		$service = \Solr::service();
+		foreach (\Solr::get_indexes($this->indexClass) as $index) {
+			$core = $index->getIndexName();
+			if (!$service->coreIsActive($core)) {
+				$brokenCores[] = $core;
+			}
+		}
 
-        if (!empty($brokenCores)) {
-            return [
-                EnvironmentCheck::ERROR,
-                'The following indexes are unavailable: ' . implode($brokenCores, ', ')
-            ];
-        }
+		if (!empty($brokenCores)) {
+			return [
+				EnvironmentCheck::ERROR,
+				'The following indexes are unavailable: ' . implode($brokenCores, ', ')
+			];
+		}
 
-        return [EnvironmentCheck::OK, 'Expected indexes are available.'];
-    }
+		return [EnvironmentCheck::OK, 'Expected indexes are available.'];
+	}
 }

src/Checks/SMTPConnectCheck.php

Indentation +55 added lines, -55 removed lines

@@ -13,67 +13,67 @@
  */
 class SMTPConnectCheck implements EnvironmentCheck
 {
-    /**
-     * @var string
-     */
-    protected $host;
+	/**
+	 * @var string
+	 */
+	protected $host;
 
-    /**
-     * @var int
-     */
-    protected $port;
+	/**
+	 * @var int
+	 */
+	protected $port;
 
-    /**
-     * Timeout (in seconds).
-     *
-     * @var int
-     */
-    protected $timeout;
+	/**
+	 * Timeout (in seconds).
+	 *
+	 * @var int
+	 */
+	protected $timeout;
 
-    /**
-     * @param null|string $host
-     * @param null|int $port
-     * @param int $timeout
-     */
-    public function __construct($host = null, $port = null, $timeout = 15)
-    {
-        $this->host = ($host) ? $host : ini_get('SMTP');
-        if (!$this->host) {
-            $this->host = 'localhost';
-        }
+	/**
+	 * @param null|string $host
+	 * @param null|int $port
+	 * @param int $timeout
+	 */
+	public function __construct($host = null, $port = null, $timeout = 15)
+	{
+		$this->host = ($host) ? $host : ini_get('SMTP');
+		if (!$this->host) {
+			$this->host = 'localhost';
+		}
 
-        $this->port = ($port) ? $port : ini_get('smtp_port');
-        if (!$this->port) {
-            $this->port = 25;
-        }
+		$this->port = ($port) ? $port : ini_get('smtp_port');
+		if (!$this->port) {
+			$this->port = 25;
+		}
 
-        $this->timeout = $timeout;
-    }
+		$this->timeout = $timeout;
+	}
 
-    /**
-     * {@inheritDoc}
-     *
-     * @return array
-     */
-    public function check()
-    {
-        $f = @fsockopen($this->host, $this->port, $errno, $errstr, $this->timeout);
-        if (!$f) {
-            return [
-                EnvironmentCheck::ERROR,
-                sprintf("Couldn't connect to SMTP on %s:%s (Error: %s %s)", $this->host, $this->port, $errno, $errstr)
-            ];
-        }
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @return array
+	 */
+	public function check()
+	{
+		$f = @fsockopen($this->host, $this->port, $errno, $errstr, $this->timeout);
+		if (!$f) {
+			return [
+				EnvironmentCheck::ERROR,
+				sprintf("Couldn't connect to SMTP on %s:%s (Error: %s %s)", $this->host, $this->port, $errno, $errstr)
+			];
+		}
 
-        fwrite($f, "HELO its_me\r\n");
-        $response = fread($f, 26);
-        if (substr($response, 0, 3) != '220') {
-            return [
-                EnvironmentCheck::ERROR,
-                sprintf('Invalid mail server response: %s', $response)
-            ];
-        }
+		fwrite($f, "HELO its_me\r\n");
+		$response = fread($f, 26);
+		if (substr($response, 0, 3) != '220') {
+			return [
+				EnvironmentCheck::ERROR,
+				sprintf('Invalid mail server response: %s', $response)
+			];
+		}
 
-        return [EnvironmentCheck::OK, ''];
-    }
+		return [EnvironmentCheck::OK, ''];
+	}
 }

src/Checks/DatabaseCheck.php

Indentation +34 added lines, -34 removed lines

@@ -13,38 +13,38 @@
  */
 class DatabaseCheck implements EnvironmentCheck
 {
-    /**
-     * @var string
-     */
-    protected $checkTable;
-
-    /**
-     * By default, Member will be checked.
-     *
-     * @param string $checkTable
-     */
-    public function __construct($checkTable = 'Member')
-    {
-        $this->checkTable = $checkTable;
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @return array
-     */
-    public function check()
-    {
-        if (!DB::get_schema()->hasTable($this->checkTable)) {
-            return [EnvironmentCheck::ERROR, "$this->checkTable not present in the database"];
-        }
-
-        $count = DB::query("SELECT COUNT(*) FROM \"$this->checkTable\"")->value();
-
-        if ($count > 0) {
-            return [EnvironmentCheck::OK, ''];
-        }
-
-        return [EnvironmentCheck::WARNING, "$this->checkTable queried ok but has no records"];
-    }
+	/**
+	 * @var string
+	 */
+	protected $checkTable;
+
+	/**
+	 * By default, Member will be checked.
+	 *
+	 * @param string $checkTable
+	 */
+	public function __construct($checkTable = 'Member')
+	{
+		$this->checkTable = $checkTable;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @return array
+	 */
+	public function check()
+	{
+		if (!DB::get_schema()->hasTable($this->checkTable)) {
+			return [EnvironmentCheck::ERROR, "$this->checkTable not present in the database"];
+		}
+
+		$count = DB::query("SELECT COUNT(*) FROM \"$this->checkTable\"")->value();
+
+		if ($count > 0) {
+			return [EnvironmentCheck::OK, ''];
+		}
+
+		return [EnvironmentCheck::WARNING, "$this->checkTable queried ok but has no records"];
+	}
 }

src/Checks/HasFunctionCheck.php

Indentation +23 added lines, -23 removed lines

@@ -11,29 +11,29 @@
  */
 class HasFunctionCheck implements EnvironmentCheck
 {
-    /**
-     * @var string
-     */
-    protected $functionName;
+	/**
+	 * @var string
+	 */
+	protected $functionName;
 
-    /**
-     * @param string $functionName The name of the function to look for.
-     */
-    public function __construct($functionName)
-    {
-        $this->functionName = $functionName;
-    }
+	/**
+	 * @param string $functionName The name of the function to look for.
+	 */
+	public function __construct($functionName)
+	{
+		$this->functionName = $functionName;
+	}
 
-    /**
-     * {@inheritDoc}
-     *
-     * @return array
-     */
-    public function check()
-    {
-        if (function_exists($this->functionName)) {
-            return [EnvironmentCheck::OK, $this->functionName . '() exists'];
-        }
-        return [EnvironmentCheck::ERROR, $this->functionName . '() doesn\'t exist'];
-    }
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @return array
+	 */
+	public function check()
+	{
+		if (function_exists($this->functionName)) {
+			return [EnvironmentCheck::OK, $this->functionName . '() exists'];
+		}
+		return [EnvironmentCheck::ERROR, $this->functionName . '() doesn\'t exist'];
+	}
 }