silverstripe / silverstripe-environmentcheck

src/Checks/FileAgeCheck.php

Indentation +110 added lines, -110 removed lines

@@ -28,124 +28,124 @@
  */
 class FileAgeCheck implements EnvironmentCheck
 {
-    /**
-     * @var int
-     */
-    const CHECK_SINGLE = 1;
+	/**
+	 * @var int
+	 */
+	const CHECK_SINGLE = 1;
 
-    /**
-     * @var int
-     */
-    const CHECK_ALL = 2;
+	/**
+	 * @var int
+	 */
+	const CHECK_ALL = 2;
 
-    /**
-     * Absolute path to a file or folder, compatible with glob().
-     *
-     * @var string
-     */
-    protected $path;
+	/**
+	 * Absolute path to a file or folder, compatible with glob().
+	 *
+	 * @var string
+	 */
+	protected $path;
 
-    /**
-     * Relative date specification, compatible with strtotime().
-     *
-     * @var string
-     */
-    protected $relativeAge;
+	/**
+	 * Relative date specification, compatible with strtotime().
+	 *
+	 * @var string
+	 */
+	protected $relativeAge;
 
-    /**
-     * The function to use for checking file age: so filemtime(), filectime(), or fileatime().
-     *
-     * @var string
-     */
-    protected $checkFn;
+	/**
+	 * The function to use for checking file age: so filemtime(), filectime(), or fileatime().
+	 *
+	 * @var string
+	 */
+	protected $checkFn;
 
-    /**
-     * Constant, check for a single file to match age criteria, or all of them.
-     *
-     * @var int
-     */
-    protected $checkType;
+	/**
+	 * Constant, check for a single file to match age criteria, or all of them.
+	 *
+	 * @var int
+	 */
+	protected $checkType;
 
-    /**
-     * Type of comparison (either > or <).
-     *
-     * @var string
-     */
-    protected $compareOperand;
+	/**
+	 * Type of comparison (either > or <).
+	 *
+	 * @var string
+	 */
+	protected $compareOperand;
 
-    /**
-     * @param string $path
-     * @param string $relativeAge
-     * @param string $compareOperand
-     * @param null|int $checkType
-     * @param string $checkFn
-     */
-    public function __construct($path, $relativeAge, $compareOperand = '>', $checkType = null, $checkFn = 'filemtime')
-    {
-        $this->path = $path;
-        $this->relativeAge = $relativeAge;
-        $this->checkFn = $checkFn;
-        $this->checkType = ($checkType) ? $checkType : self::CHECK_SINGLE;
-        $this->compareOperand = $compareOperand;
-    }
+	/**
+	 * @param string $path
+	 * @param string $relativeAge
+	 * @param string $compareOperand
+	 * @param null|int $checkType
+	 * @param string $checkFn
+	 */
+	public function __construct($path, $relativeAge, $compareOperand = '>', $checkType = null, $checkFn = 'filemtime')
+	{
+		$this->path = $path;
+		$this->relativeAge = $relativeAge;
+		$this->checkFn = $checkFn;
+		$this->checkType = ($checkType) ? $checkType : self::CHECK_SINGLE;
+		$this->compareOperand = $compareOperand;
+	}
 
-    /**
-     * {@inheritDoc}
-     *
-     * @return array
-     */
-    public function check()
-    {
-        $cutoffTime =  strtotime($this->relativeAge, DBDatetime::now()->Format('U'));
-        $files = $this->getFiles();
-        $invalidFiles = [];
-        $validFiles = [];
-        $checkFn = $this->checkFn;
-        $allValid = true;
-        if ($files) {
-            foreach ($files as $file) {
-                $fileTime = $checkFn($file);
-                $valid = ($this->compareOperand == '>') ? ($fileTime >= $cutoffTime) : ($fileTime <= $cutoffTime);
-                if ($valid) {
-                    $validFiles[] = $file;
-                } else {
-                    $invalidFiles[] = $file;
-                    if ($this->checkType == self::CHECK_ALL) {
-                        return [
-                            EnvironmentCheck::ERROR,
-                            sprintf(
-                                'File "%s" doesn\'t match age check (compare %s: %s, actual: %s)',
-                                $file,
-                                $this->compareOperand,
-                                date('c', $cutoffTime),
-                                date('c', $fileTime)
-                            )
-                        ];
-                    }
-                }
-            }
-        }
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @return array
+	 */
+	public function check()
+	{
+		$cutoffTime =  strtotime($this->relativeAge, DBDatetime::now()->Format('U'));
+		$files = $this->getFiles();
+		$invalidFiles = [];
+		$validFiles = [];
+		$checkFn = $this->checkFn;
+		$allValid = true;
+		if ($files) {
+			foreach ($files as $file) {
+				$fileTime = $checkFn($file);
+				$valid = ($this->compareOperand == '>') ? ($fileTime >= $cutoffTime) : ($fileTime <= $cutoffTime);
+				if ($valid) {
+					$validFiles[] = $file;
+				} else {
+					$invalidFiles[] = $file;
+					if ($this->checkType == self::CHECK_ALL) {
+						return [
+							EnvironmentCheck::ERROR,
+							sprintf(
+								'File "%s" doesn\'t match age check (compare %s: %s, actual: %s)',
+								$file,
+								$this->compareOperand,
+								date('c', $cutoffTime),
+								date('c', $fileTime)
+							)
+						];
+					}
+				}
+			}
+		}
 
-        // If at least one file was valid, count as passed
-        if ($this->checkType == self::CHECK_SINGLE && count($invalidFiles) < count($files)) {
-            return [EnvironmentCheck::OK, ''];
-        }
-        if (count($invalidFiles) == 0) {
-            return [EnvironmentCheck::OK, ''];
-        }
-        return [
-            EnvironmentCheck::ERROR,
-            sprintf('No files matched criteria (%s %s)', $this->compareOperand, date('c', $cutoffTime))
-        ];
-    }
+		// If at least one file was valid, count as passed
+		if ($this->checkType == self::CHECK_SINGLE && count($invalidFiles) < count($files)) {
+			return [EnvironmentCheck::OK, ''];
+		}
+		if (count($invalidFiles) == 0) {
+			return [EnvironmentCheck::OK, ''];
+		}
+		return [
+			EnvironmentCheck::ERROR,
+			sprintf('No files matched criteria (%s %s)', $this->compareOperand, date('c', $cutoffTime))
+		];
+	}
 
-    /**
-     * Gets a list of absolute file paths.
-     *
-     * @return array
-     */
-    protected function getFiles()
-    {
-        return glob($this->path);
-    }
+	/**
+	 * Gets a list of absolute file paths.
+	 *
+	 * @return array
+	 */
+	protected function getFiles()
+	{
+		return glob($this->path);
+	}
 }

src/Checks/HasClassCheck.php

Indentation +23 added lines, -23 removed lines

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

src/Checks/FileWriteableCheck.php

Indentation +64 added lines, -64 removed lines

@@ -11,77 +11,77 @@
  */
 class FileWriteableCheck implements EnvironmentCheck
 {
-    /**
-     * @var string
-     */
-    protected $path;
+	/**
+	 * @var string
+	 */
+	protected $path;
 
-    /**
-     * @param string $path The full path. If a relative path, it will relative to the BASE_PATH.
-     */
-    public function __construct($path)
-    {
-        $this->path = $path;
-    }
+	/**
+	 * @param string $path The full path. If a relative path, it will relative to the BASE_PATH.
+	 */
+	public function __construct($path)
+	{
+		$this->path = $path;
+	}
 
-    /**
-     * {@inheritDoc}
-     *
-     * @return array
-     */
-    public function check()
-    {
-        if ($this->path[0] == '/') {
-            $filename = $this->path;
-        } else {
-            $filename = BASE_PATH . DIRECTORY_SEPARATOR . str_replace('/', DIRECTORY_SEPARATOR, $this->path);
-        }
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @return array
+	 */
+	public function check()
+	{
+		if ($this->path[0] == '/') {
+			$filename = $this->path;
+		} else {
+			$filename = BASE_PATH . DIRECTORY_SEPARATOR . str_replace('/', DIRECTORY_SEPARATOR, $this->path);
+		}
 
-        if (file_exists($filename)) {
-            $isWriteable = is_writeable($filename);
-        } else {
-            $isWriteable = is_writeable(dirname($filename));
-        }
+		if (file_exists($filename)) {
+			$isWriteable = is_writeable($filename);
+		} else {
+			$isWriteable = is_writeable(dirname($filename));
+		}
 
-        if (!$isWriteable) {
-            if (function_exists('posix_getgroups')) {
-                $userID = posix_geteuid();
-                $user = posix_getpwuid($userID);
+		if (!$isWriteable) {
+			if (function_exists('posix_getgroups')) {
+				$userID = posix_geteuid();
+				$user = posix_getpwuid($userID);
 
-                $currentOwnerID = fileowner(file_exists($filename) ? $filename : dirname($filename));
-                $currentOwner = posix_getpwuid($currentOwnerID);
+				$currentOwnerID = fileowner(file_exists($filename) ? $filename : dirname($filename));
+				$currentOwner = posix_getpwuid($currentOwnerID);
 
-                $message = "User '$user[name]' needs to be able to write to this file:\n$filename\n\nThe file is "
-                    . "currently owned by '$currentOwner[name]'.  ";
+				$message = "User '$user[name]' needs to be able to write to this file:\n$filename\n\nThe file is "
+					. "currently owned by '$currentOwner[name]'.  ";
 
-                if ($user['name'] == $currentOwner['name']) {
-                    $message .= 'We recommend that you make the file writeable.';
-                } else {
-                    $groups = posix_getgroups();
-                    $groupList = [];
-                    foreach ($groups as $group) {
-                        $groupInfo = posix_getgrgid($group);
-                        if (in_array($currentOwner['name'], $groupInfo['members'])) {
-                            $groupList[] = $groupInfo['name'];
-                        }
-                    }
-                    if ($groupList) {
-                        $message .= "	We recommend that you make the file group-writeable and change the group to "
-                            . "one of these groups:\n - " . implode("\n - ", $groupList)
-                            . "\n\nFor example:\nchmod g+w $filename\nchgrp " . $groupList[0] . " $filename";
-                    } else {
-                        $message .= "  There is no user-group that contains both the web-server user and the owner "
-                            . "of this file.  Change the ownership of the file, create a new group, or temporarily "
-                            . "make the file writeable by everyone during the install process.";
-                    }
-                }
-            } else {
-                $message = "The webserver user needs to be able to write to this file:\n$filename";
-            }
+				if ($user['name'] == $currentOwner['name']) {
+					$message .= 'We recommend that you make the file writeable.';
+				} else {
+					$groups = posix_getgroups();
+					$groupList = [];
+					foreach ($groups as $group) {
+						$groupInfo = posix_getgrgid($group);
+						if (in_array($currentOwner['name'], $groupInfo['members'])) {
+							$groupList[] = $groupInfo['name'];
+						}
+					}
+					if ($groupList) {
+						$message .= "	We recommend that you make the file group-writeable and change the group to "
+							. "one of these groups:\n - " . implode("\n - ", $groupList)
+							. "\n\nFor example:\nchmod g+w $filename\nchgrp " . $groupList[0] . " $filename";
+					} else {
+						$message .= "  There is no user-group that contains both the web-server user and the owner "
+							. "of this file.  Change the ownership of the file, create a new group, or temporarily "
+							. "make the file writeable by everyone during the install process.";
+					}
+				}
+			} else {
+				$message = "The webserver user needs to be able to write to this file:\n$filename";
+			}
 
-            return [EnvironmentCheck::ERROR, $message];
-        }
+			return [EnvironmentCheck::ERROR, $message];
+		}
 
-        return [EnvironmentCheck::OK, ''];
-    }
+		return [EnvironmentCheck::OK, ''];
+	}
 }

tests/Controllers/DevHealthControllerTest.php

Indentation +17 added lines, -17 removed lines

@@ -16,27 +16,27 @@
  */
 class DevHealthControllerTest extends SapphireTest
 {
-    /**
-     * {@inheritDoc}
-     * @var array
-     */
-    protected $usesDatabase = true;
+	/**
+	 * {@inheritDoc}
+	 * @var array
+	 */
+	protected $usesDatabase = true;
 
-    public function testIndexCreatesChecker()
-    {
-        $controller = new DevHealthController();
+	public function testIndexCreatesChecker()
+	{
+		$controller = new DevHealthController();
 
-        $request = new HTTPRequest('GET', 'example.com');
+		$request = new HTTPRequest('GET', 'example.com');
 
-        // we need to fake authenticated access as BasicAuth::requireLogin doesn't like empty
-        // permission type strings, which is what health check uses.
+		// we need to fake authenticated access as BasicAuth::requireLogin doesn't like empty
+		// permission type strings, which is what health check uses.
 
-        putenv('ENVCHECK_BASICAUTH_USERNAME="foo"');
-        putenv('ENVCHECK_BASICAUTH_PASSWORD="bar"');
+		putenv('ENVCHECK_BASICAUTH_USERNAME="foo"');
+		putenv('ENVCHECK_BASICAUTH_PASSWORD="bar"');
 
-        $_SERVER['PHP_AUTH_USER'] = 'foo';
-        $_SERVER['PHP_AUTH_PW'] = 'bar';
+		$_SERVER['PHP_AUTH_USER'] = 'foo';
+		$_SERVER['PHP_AUTH_PW'] = 'bar';
 
-        $this->assertInstanceOf(EnvironmentChecker::class, $controller->index($request));
-    }
+		$this->assertInstanceOf(EnvironmentChecker::class, $controller->index($request));
+	}
 }

tests/Controllers/DevCheckControllerTest.php

Indentation +11 added lines, -11 removed lines

@@ -16,18 +16,18 @@
  */
 class DevCheckControllerTest extends SapphireTest
 {
-    /**
-     * {@inheritDoc}
-     * @var array
-     */
-    protected $usesDatabase = true;
+	/**
+	 * {@inheritDoc}
+	 * @var array
+	 */
+	protected $usesDatabase = true;
 
-    public function testIndexCreatesChecker()
-    {
-        $controller = new DevCheckController();
+	public function testIndexCreatesChecker()
+	{
+		$controller = new DevCheckController();
 
-        $request = new HTTPRequest('GET', 'example.com');
+		$request = new HTTPRequest('GET', 'example.com');
 
-        $this->assertInstanceOf(EnvironmentChecker::class, $controller->index($request));
-    }
+		$this->assertInstanceOf(EnvironmentChecker::class, $controller->index($request));
+	}
 }

tests/Checks/URLCheckTest.php

Indentation +9 added lines, -9 removed lines

@@ -15,15 +15,15 @@
  */
 class URLCheckTest extends SapphireTest
 {
-    public function testCheckReportsMissingPages()
-    {
-        $check = new URLCheck('foo', 'bar');
+	public function testCheckReportsMissingPages()
+	{
+		$check = new URLCheck('foo', 'bar');
 
-        $expected = [
-            EnvironmentCheck::ERROR,
-            'Error retrieving "foo" (Code: 404)'
-        ];
+		$expected = [
+			EnvironmentCheck::ERROR,
+			'Error retrieving "foo" (Code: 404)'
+		];
 
-        $this->assertEquals($expected, $check->check());
-    }
+		$this->assertEquals($expected, $check->check());
+	}
 }

tests/Checks/FileWritableCheckTest.php

Indentation +15 added lines, -15 removed lines

@@ -15,24 +15,24 @@
  */
 class FileWritableCheckTest extends SapphireTest
 {
-    public function testCheckReportsWritablePaths()
-    {
-        $check = new FileWriteableCheck(TEMP_FOLDER);
+	public function testCheckReportsWritablePaths()
+	{
+		$check = new FileWriteableCheck(TEMP_FOLDER);
 
-        $expected = [
-            EnvironmentCheck::OK,
-            ''
-        ];
+		$expected = [
+			EnvironmentCheck::OK,
+			''
+		];
 
-        $this->assertEquals($expected, $check->check());
-    }
+		$this->assertEquals($expected, $check->check());
+	}
 
-    public function testCheckReportsNonWritablePaths()
-    {
-        $check = new FileWriteableCheck('/var');
+	public function testCheckReportsNonWritablePaths()
+	{
+		$check = new FileWriteableCheck('/var');
 
-        $result = $check->check();
+		$result = $check->check();
 
-        $this->assertEquals(EnvironmentCheck::ERROR, $result[0]);
-    }
+		$this->assertEquals(EnvironmentCheck::ERROR, $result[0]);
+	}
 }

tests/Checks/ExternalURLCheckTest.php

Indentation +10 added lines, -10 removed lines

@@ -15,17 +15,17 @@
  */
 class ExternalURLCheckTest extends SapphireTest
 {
-    public function testCheckReportsMissingPages()
-    {
-        $this->markTestSkipped('ExternalURLCheck seems faulty on some systems');
+	public function testCheckReportsMissingPages()
+	{
+		$this->markTestSkipped('ExternalURLCheck seems faulty on some systems');
 
-        $check = new ExternalURLCheck('http://missing-site/');
+		$check = new ExternalURLCheck('http://missing-site/');
 
-        $expected = [
-            EnvironmentCheck::ERROR,
-            'Success retrieving "http://missing-site/" (Code: 404)'
-        ];
+		$expected = [
+			EnvironmentCheck::ERROR,
+			'Success retrieving "http://missing-site/" (Code: 404)'
+		];
 
-        $this->assertEquals($expected, $check->check());
-    }
+		$this->assertEquals($expected, $check->check());
+	}
 }

tests/Checks/HasClassCheckTest.php

Indentation +18 added lines, -18 removed lines

@@ -15,27 +15,27 @@
  */
 class HasClassCheckTest extends SapphireTest
 {
-    public function testCheckReportsMissingClasses()
-    {
-        $check = new HasClassCheck('foo');
+	public function testCheckReportsMissingClasses()
+	{
+		$check = new HasClassCheck('foo');
 
-        $expected = [
-            EnvironmentCheck::ERROR,
-            'Class foo doesn\'t exist'
-        ];
+		$expected = [
+			EnvironmentCheck::ERROR,
+			'Class foo doesn\'t exist'
+		];
 
-        $this->assertEquals($expected, $check->check());
-    }
+		$this->assertEquals($expected, $check->check());
+	}
 
-    public function testCheckReportsFoundClasses()
-    {
-        $check = new HasClassCheck('stdClass');
+	public function testCheckReportsFoundClasses()
+	{
+		$check = new HasClassCheck('stdClass');
 
-        $expected = [
-            EnvironmentCheck::OK,
-            'Class stdClass exists',
-        ];
+		$expected = [
+			EnvironmentCheck::OK,
+			'Class stdClass exists',
+		];
 
-        $this->assertEquals($expected, $check->check());
-    }
+		$this->assertEquals($expected, $check->check());
+	}
 }