Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More helpful error message in checkEnvironment.php #958

Merged
merged 4 commits into from
Apr 18, 2019
Merged

More helpful error message in checkEnvironment.php #958

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53e6926
Add check for directory existence
amosfolz Mar 28, 2019
9743150
Provide more helpful error when directiory is missing
amosfolz Apr 3, 2019
16d534a
Update CheckEnvironment.php
amosfolz Apr 6, 2019
f9a3398
styling fixes
amosfolz Apr 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 40 additions & 12 deletions app/sprinkles/core/src/Util/CheckEnvironment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@ public function checkAll()
$problemsFound = true;
}

if ($this->checkDirectories()) {
$problemsFound = true;
// Skip checkPermissions() if the required directories do not exist.
return $problemsFound;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Careful with the indentation here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the information! I will look over the PSR guides and get more familiar with the UF style guide as well.

}

if ($this->checkPermissions()) {
$problemsFound = true;
}
Expand Down Expand Up @@ -257,6 +263,39 @@ public function checkPdo()
return $problemsFound;
}

/**
* Check that log, cache, and session directories exist.
*/
public function checkDirectories()
{
$problemsFound = false;

$directoryPaths = [
"logs" => $this->locator->findResource('log://'),
"cache" => $this->locator->findResource('cache://'),
"sessions" => $this->locator->findResource('session://')
];

foreach ($directoryPaths as $directory => $path) {
if ($path == null) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation should be 4 spaces

$problemsFound = true;
$this->resultsFailed['directory-' . $directory] = [
'title' => "<i class='fa fa-file-o fa-fw'></i> A required directory was not found.",
'message' => "Please check that <code>userfrosting/app/$directory</code> exists.",
'success' => false
];
}
else {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brace should be on the same line per PSR-2
https://www.php-fig.org/psr/psr-2/#51-if-elseif-else

$this->resultsSuccess['directory-' . $directory] = [
'title' => "<i class='fa fa-file-o fa-fw'></i> File/directory check passed!",
'message' => "<code>userfrosting/app/$directory</code> exists.",
'success' => true
];
}
}
return $problemsFound;
}

/**
* Check that log, cache, and session directories are writable, and that other directories are set appropriately for the environment.
*/
Expand All @@ -280,15 +319,6 @@ public function checkPermissions()

// Check for essential files & perms
foreach ($shouldBeWriteable as $file => $assertWriteable) {
$is_dir = false;
if (!file_exists($file)) {
$problemsFound = true;
$this->resultsFailed['file-' . $file] = [
'title' => "<i class='fa fa-file-o fa-fw'></i> File or directory does not exist.",
'message' => "We could not find the file or directory <code>$file</code>.",
'success' => false
];
} else {
$writeable = is_writable($file);
if ($assertWriteable !== $writeable) {
$problemsFound = true;
Expand All @@ -311,10 +341,8 @@ public function checkPermissions()
. '</b>.',
'success' => true
];
}
}
}
}

return $problemsFound;
}

Expand Down