mirror of
https://github.com/laravel/valet.git
synced 2026-02-04 16:10:08 +01:00
6e01bfb5f4
`valet uninstall` only displays information about how to manually uninstall and clean up after Valet. This PR adds a `--force` parameter, which will forcefully remove Valet and the Homebrew services it installs, as well as clean up the config files and log files. But for a few post-uninstall composer dependencies, cleanup is very thorough. This brings idempotency to both `valet install` and `valet uninstall --force` (There may still be edge cases where other Homebrew or composer packages might create interference with install/uninstall, but this makes things much easier to self-troubleshoot.)
385 lines
9.4 KiB
PHP
385 lines
9.4 KiB
PHP
<?php
|
|
|
|
namespace Valet;
|
|
|
|
use DomainException;
|
|
|
|
class Brew
|
|
{
|
|
const SUPPORTED_PHP_VERSIONS = [
|
|
'php',
|
|
'php@7.4',
|
|
'php@7.3',
|
|
'php@7.2',
|
|
'php@7.1',
|
|
'php@7.0',
|
|
'php@5.6',
|
|
'php73',
|
|
'php72',
|
|
'php71',
|
|
'php70',
|
|
'php56'
|
|
];
|
|
|
|
const LATEST_PHP_VERSION = 'php@7.4';
|
|
|
|
var $cli, $files;
|
|
|
|
/**
|
|
* Create a new Brew instance.
|
|
*
|
|
* @param CommandLine $cli
|
|
* @param Filesystem $files
|
|
* @return void
|
|
*/
|
|
function __construct(CommandLine $cli, Filesystem $files)
|
|
{
|
|
$this->cli = $cli;
|
|
$this->files = $files;
|
|
}
|
|
|
|
/**
|
|
* Determine if the given formula is installed.
|
|
*
|
|
* @param string $formula
|
|
* @return bool
|
|
*/
|
|
function installed($formula)
|
|
{
|
|
return in_array($formula, explode(PHP_EOL, $this->cli->runAsUser('brew list | grep '.$formula)));
|
|
}
|
|
|
|
/**
|
|
* Determine if a compatible PHP version is Homebrewed.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function hasInstalledPhp()
|
|
{
|
|
return $this->supportedPhpVersions()->contains(function ($version) {
|
|
return $this->installed($version);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get a list of supported PHP versions.
|
|
*
|
|
* @return \Illuminate\Support\Collection
|
|
*/
|
|
function supportedPhpVersions()
|
|
{
|
|
return collect(static::SUPPORTED_PHP_VERSIONS);
|
|
}
|
|
|
|
/**
|
|
* Determine if a compatible nginx version is Homebrewed.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function hasInstalledNginx()
|
|
{
|
|
return $this->installed('nginx')
|
|
|| $this->installed('nginx-full');
|
|
}
|
|
|
|
/**
|
|
* Return name of the nginx service installed via Homebrew.
|
|
*
|
|
* @return string
|
|
*/
|
|
function nginxServiceName()
|
|
{
|
|
return $this->installed('nginx-full') ? 'nginx-full' : 'nginx';
|
|
}
|
|
|
|
/**
|
|
* Ensure that the given formula is installed.
|
|
*
|
|
* @param string $formula
|
|
* @param array $options
|
|
* @param array $taps
|
|
* @return void
|
|
*/
|
|
function ensureInstalled($formula, $options = [], $taps = [])
|
|
{
|
|
if (! $this->installed($formula)) {
|
|
$this->installOrFail($formula, $options, $taps);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Install the given formula and throw an exception on failure.
|
|
*
|
|
* @param string $formula
|
|
* @param array $options
|
|
* @param array $taps
|
|
* @return void
|
|
*/
|
|
function installOrFail($formula, $options = [], $taps = [])
|
|
{
|
|
info("Installing {$formula}...");
|
|
|
|
if (count($taps) > 0) {
|
|
$this->tap($taps);
|
|
}
|
|
|
|
output('<info>['.$formula.'] is not installed, installing it now via Brew...</info> 🍻');
|
|
|
|
$this->cli->runAsUser(trim('brew install '.$formula.' '.implode(' ', $options)), function ($exitCode, $errorOutput) use ($formula) {
|
|
output($errorOutput);
|
|
|
|
throw new DomainException('Brew was unable to install ['.$formula.'].');
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Tap the given formulas.
|
|
*
|
|
* @param dynamic[string] $formula
|
|
* @return void
|
|
*/
|
|
function tap($formulas)
|
|
{
|
|
$formulas = is_array($formulas) ? $formulas : func_get_args();
|
|
|
|
foreach ($formulas as $formula) {
|
|
$this->cli->passthru('sudo -u "'.user().'" brew tap '.$formula);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Restart the given Homebrew services.
|
|
*
|
|
* @param
|
|
*/
|
|
function restartService($services)
|
|
{
|
|
$services = is_array($services) ? $services : func_get_args();
|
|
|
|
foreach ($services as $service) {
|
|
if ($this->installed($service)) {
|
|
info("Restarting {$service}...");
|
|
|
|
$this->cli->quietly('sudo brew services stop '.$service);
|
|
$this->cli->quietly('sudo brew services start '.$service);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Stop the given Homebrew services.
|
|
*
|
|
* @param
|
|
*/
|
|
function stopService($services)
|
|
{
|
|
$services = is_array($services) ? $services : func_get_args();
|
|
|
|
foreach ($services as $service) {
|
|
if ($this->installed($service)) {
|
|
info("Stopping {$service}...");
|
|
|
|
$this->cli->quietly('sudo brew services stop '.$service);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determine if php is currently linked.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function hasLinkedPhp()
|
|
{
|
|
return $this->files->isLink('/usr/local/bin/php');
|
|
}
|
|
|
|
/**
|
|
* Get the linked php parsed.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
function getParsedLinkedPhp()
|
|
{
|
|
if (! $this->hasLinkedPhp()) {
|
|
throw new DomainException("Homebrew PHP appears not to be linked.");
|
|
}
|
|
|
|
$resolvedPath = $this->files->readLink('/usr/local/bin/php');
|
|
|
|
/**
|
|
* Typical homebrew path resolutions are like:
|
|
* "../Cellar/php@7.2/7.2.13/bin/php"
|
|
* or older styles:
|
|
* "../Cellar/php/7.2.9_2/bin/php
|
|
* "../Cellar/php55/bin/php
|
|
*/
|
|
preg_match('~\w{3,}/(php)(@?\d\.?\d)?/(\d\.\d)?([_\d\.]*)?/?\w{3,}~', $resolvedPath, $matches);
|
|
|
|
return $matches;
|
|
}
|
|
|
|
/**
|
|
* Gets the currently linked formula
|
|
* E.g if under php, will be php, if under php@7.3 will be that
|
|
* Different to ->linkedPhp() in that this will just get the linked directory name (whether that is php, php55 or
|
|
* php@7.2)
|
|
*
|
|
* @return mixed
|
|
*/
|
|
function getLinkedPhpFormula()
|
|
{
|
|
$matches = $this->getParsedLinkedPhp();
|
|
return $matches[1] . $matches[2];
|
|
}
|
|
|
|
/**
|
|
* Determine which version of PHP is linked in Homebrew.
|
|
*
|
|
* @return string
|
|
*/
|
|
function linkedPhp()
|
|
{
|
|
$matches = $this->getParsedLinkedPhp();
|
|
$resolvedPhpVersion = $matches[3] ?: $matches[2];
|
|
|
|
return $this->supportedPhpVersions()->first(
|
|
function ($version) use ($resolvedPhpVersion) {
|
|
$resolvedVersionNormalized = preg_replace('/[^\d]/', '', $resolvedPhpVersion);
|
|
$versionNormalized = preg_replace('/[^\d]/', '', $version);
|
|
return $resolvedVersionNormalized === $versionNormalized;
|
|
}, function () use ($resolvedPhpVersion) {
|
|
throw new DomainException("Unable to determine linked PHP when parsing '$resolvedPhpVersion'");
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Restart the linked PHP-FPM Homebrew service.
|
|
*
|
|
* @return void
|
|
*/
|
|
function restartLinkedPhp()
|
|
{
|
|
$this->restartService($this->getLinkedPhpFormula());
|
|
}
|
|
|
|
/**
|
|
* Create the "sudoers.d" entry for running Brew.
|
|
*
|
|
* @return void
|
|
*/
|
|
function createSudoersEntry()
|
|
{
|
|
$this->files->ensureDirExists('/etc/sudoers.d');
|
|
|
|
$this->files->put('/etc/sudoers.d/brew', 'Cmnd_Alias BREW = /usr/local/bin/brew *
|
|
%admin ALL=(root) NOPASSWD:SETENV: BREW'.PHP_EOL);
|
|
}
|
|
|
|
/**
|
|
* Remove the "sudoers.d" entry for running Brew.
|
|
*
|
|
* @return void
|
|
*/
|
|
function removeSudoersEntry()
|
|
{
|
|
$this->cli->quietly('rm /etc/sudoers.d/brew');
|
|
}
|
|
|
|
/**
|
|
* Link passed formula.
|
|
*
|
|
* @param $formula
|
|
* @param bool $force
|
|
*
|
|
* @return string
|
|
*/
|
|
function link($formula, $force = false)
|
|
{
|
|
return $this->cli->runAsUser(
|
|
sprintf('brew link %s%s', $formula, $force ? ' --force': ''),
|
|
function ($exitCode, $errorOutput) use ($formula) {
|
|
output($errorOutput);
|
|
|
|
throw new DomainException('Brew was unable to link [' . $formula . '].');
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Unlink passed formula.
|
|
* @param $formula
|
|
*
|
|
* @return string
|
|
*/
|
|
function unlink($formula)
|
|
{
|
|
return $this->cli->runAsUser(
|
|
sprintf('brew unlink %s', $formula),
|
|
function ($exitCode, $errorOutput) use ($formula) {
|
|
output($errorOutput);
|
|
|
|
throw new DomainException('Brew was unable to unlink [' . $formula . '].');
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the currently running brew services.
|
|
*
|
|
* @return \Illuminate\Support\Collection
|
|
*/
|
|
function getRunningServices()
|
|
{
|
|
return collect(array_filter(explode(PHP_EOL, $this->cli->runAsUser(
|
|
'brew services list | grep started | awk \'{ print $1; }\'',
|
|
function ($exitCode, $errorOutput) {
|
|
output($errorOutput);
|
|
|
|
throw new DomainException('Brew was unable to check which services are running.');
|
|
}
|
|
))));
|
|
}
|
|
|
|
/**
|
|
* Tell Homebrew to forcefully remove all PHP versions that Valet supports.
|
|
*
|
|
* @return string
|
|
*/
|
|
function uninstallAllPhpVersions()
|
|
{
|
|
$this->supportedPhpVersions()->each(function ($formula) {
|
|
$this->uninstallFormula($formula);
|
|
});
|
|
|
|
return 'PHP versions removed.';
|
|
}
|
|
|
|
/**
|
|
* Uninstall a Homebrew app by formula name.
|
|
* @param string $formula
|
|
*
|
|
* @return void
|
|
*/
|
|
function uninstallFormula($formula)
|
|
{
|
|
$this->cli->runAsUser('brew uninstall --force '.$formula);
|
|
$this->cli->run('rm -rf /usr/local/Cellar/'.$formula);
|
|
}
|
|
|
|
/**
|
|
* Run Homebrew's cleanup commands.
|
|
*
|
|
* @return string
|
|
*/
|
|
function cleanupBrew()
|
|
{
|
|
return $this->cli->runAsUser(
|
|
'brew cleanup && brew services cleanup',
|
|
function ($exitCode, $errorOutput) {
|
|
output($errorOutput);
|
|
}
|
|
);
|
|
}
|
|
}
|