Skip to content

Commit eefc06b

Browse files
mattstauffermattstauffer
committed
Drop PHP 5.6; extract site-specific PHP version isolation to its own commands
1 parent a34073e commit eefc06b

12 files changed

+154
-150
lines changed

‎.github/workflows/tests.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
strategy:
1414
fail-fast: true
1515
matrix:
16-
php: [5.6, '7.0', 7.1, 7.2, 7.3, 7.4, '8.0', 8.1]
16+
php: ['7.0', 7.1, 7.2, 7.3, 7.4, '8.0', 8.1]
1717

1818
name: PHP ${{ matrix.php }}
1919

‎cli/Valet/Brew.php

-2
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,10 @@ class Brew
1515
'[email protected]',
1616
'[email protected]',
1717
'[email protected]',
18-
'[email protected]',
1918
'php73',
2019
'php72',
2120
'php71',
2221
'php70',
23-
'php56',
2422
];
2523

2624
const LATEST_PHP_VERSION = '[email protected]';

‎cli/Valet/PhpFpm.php

+83-101
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public function install()
5252

5353
$this->files->ensureDirExists(VALET_HOME_PATH.'/Log', user());
5454

55-
$this->updateConfiguration();
55+
$this->createConfigurationFiles();
5656

5757
$this->restart();
5858
}
@@ -70,66 +70,45 @@ public function uninstall()
7070
}
7171

7272
/**
73-
* Update the PHP FPM configuration.
73+
* Create (or re-create) the PHP FPM configuration files.
74+
* Writes FPM config file, pointing to the correct .sock file, and log and ini files
7475
*
7576
* @param string|null $phpVersion
7677
* @return void
7778
*/
78-
public function updateConfiguration($phpVersion = null)
79+
public function createConfigurationFiles($phpVersion = null)
7980
{
8081
info(sprintf('Updating PHP configuration%s...', $phpVersion ? ' for '.$phpVersion : ''));
8182

8283
$fpmConfigFile = $this->fpmConfigPath($phpVersion);
8384

8485
$this->files->ensureDirExists(dirname($fpmConfigFile), user());
8586

86-
// rename (to disable) old FPM Pool configuration, regardless of whether it's a default config or one customized by an older Valet version
87-
$oldFile = dirname($fpmConfigFile).'/www.conf';
88-
if (file_exists($oldFile)) {
89-
rename($oldFile, $oldFile.'-backup');
90-
}
91-
92-
if (false === strpos($fpmConfigFile, '5.6')) {
93-
// since PHP 7 we can simply drop in a valet-specific fpm pool config, and not touch the default config
94-
$contents = $this->files->get(__DIR__.'/../stubs/etc-phpfpm-valet.conf');
95-
$contents = str_replace(['VALET_USER', 'VALET_HOME_PATH'], [user(), VALET_HOME_PATH], $contents);
96-
} else {
97-
// for PHP 5 we must do a direct edit of the fpm pool config to switch it to Valet's needs
98-
$contents = $this->files->get($fpmConfigFile);
99-
$contents = preg_replace('/^user = .+$/m', 'user = '.user(), $contents);
100-
$contents = preg_replace('/^group = .+$/m', 'group = staff', $contents);
101-
$contents = preg_replace('/^listen = .+$/m', 'listen = '.VALET_HOME_PATH.'/valet.sock', $contents);
102-
$contents = preg_replace('/^;?listen\.owner = .+$/m', 'listen.owner = '.user(), $contents);
103-
$contents = preg_replace('/^;?listen\.group = .+$/m', 'listen.group = staff', $contents);
104-
$contents = preg_replace('/^;?listen\.mode = .+$/m', 'listen.mode = 0777', $contents);
105-
}
106-
87+
// Drop in a valet-specific fpm pool config
88+
$contents = $this->files->get(__DIR__.'/../stubs/etc-phpfpm-valet.conf');
89+
$contents = str_replace(['VALET_USER', 'VALET_HOME_PATH'], [user(), VALET_HOME_PATH], $contents);
10790
if ($phpVersion) {
10891
$contents = str_replace('valet.sock', $this->fpmSockName($phpVersion), $contents);
10992
}
110-
11193
$this->files->put($fpmConfigFile, $contents);
11294

95+
// Set log and ini files
96+
$destDir = dirname(dirname($fpmConfigFile)) . '/conf.d';
97+
$this->files->ensureDirExists($destDir, user());
98+
11399
$contents = $this->files->get(__DIR__.'/../stubs/php-memory-limits.ini');
114-
$destFile = dirname($fpmConfigFile);
115-
$destFile = str_replace('/php-fpm.d', '', $destFile);
116-
$destFile .= '/conf.d/php-memory-limits.ini';
117-
$this->files->ensureDirExists(dirname($destFile), user());
118-
$this->files->putAsUser($destFile, $contents);
100+
$this->files->putAsUser($destDir.'/php-memory-limits.ini', $contents);
119101

120102
$contents = $this->files->get(__DIR__.'/../stubs/etc-phpfpm-error_log.ini');
121103
$contents = str_replace(['VALET_USER', 'VALET_HOME_PATH'], [user(), VALET_HOME_PATH], $contents);
122-
$destFile = dirname($fpmConfigFile);
123-
$destFile = str_replace('/php-fpm.d', '', $destFile);
124-
$destFile .= '/conf.d/error_log.ini';
125-
$this->files->ensureDirExists(dirname($destFile), user());
126-
$this->files->putAsUser($destFile, $contents);
104+
$this->files->putAsUser($destDir.'/error_log.ini', $contents);
105+
127106
$this->files->ensureDirExists(VALET_HOME_PATH.'/Log', user());
128107
$this->files->touch(VALET_HOME_PATH.'/Log/php-fpm.log', user());
129108
}
130109

131110
/**
132-
* Restart the PHP FPM process.
111+
* Restart the PHP FPM process(es).
133112
*
134113
* @param string|null $phpVersion
135114
* @return void
@@ -167,9 +146,7 @@ public function fpmConfigPath($phpVersion = null)
167146
$versionNormalized = $this->normalizePhpVersion($phpVersion === 'php' ? Brew::LATEST_PHP_VERSION : $phpVersion);
168147
$versionNormalized = preg_replace('~[^\d\.]~', '', $versionNormalized);
169148

170-
return $versionNormalized === '5.6'
171-
? BREW_PREFIX.'/etc/php/5.6/php-fpm.conf'
172-
: BREW_PREFIX."/etc/php/${versionNormalized}/php-fpm.d/valet-fpm.conf";
149+
return BREW_PREFIX."/etc/php/${versionNormalized}/php-fpm.d/valet-fpm.conf";
173150
}
174151

175152
/**
@@ -187,21 +164,17 @@ public function stopRunning()
187164
}
188165

189166
/**
190-
* Stop PHP, if a specific version isn't being used globally or by any sites.
167+
* Stop a given PHP version, if a specific version isn't being used globally or by any sites.
191168
*
192169
* @param string|null $phpVersion
193170
* @return void
194171
*/
195-
public function stopIfUnused($phpVersion)
172+
public function stopIfUnused($phpVersion = null)
196173
{
197174
if (! $phpVersion) {
198175
return;
199176
}
200177

201-
if (strpos($phpVersion, 'php') === false) {
202-
$phpVersion = 'php'.$phpVersion;
203-
}
204-
205178
$phpVersion = $this->normalizePhpVersion($phpVersion);
206179

207180
if (! in_array($phpVersion, $this->utilizedPhpVersions())) {
@@ -210,38 +183,69 @@ public function stopIfUnused($phpVersion)
210183
}
211184

212185
/**
213-
* Use a specific version of php.
186+
* Isolate a given directory to use a specific version of php.
214187
*
188+
* @param string $directory
215189
* @param string $version
216-
* @param bool $force
217-
* @param string|null $directory
218-
* @return string|void
190+
* @return void
219191
*/
220-
public function useVersion($version, $force = false, $directory = null)
192+
public function isolateDirectoryToVersion($directory, $version)
221193
{
222-
if ($directory) {
223-
$site = $this->site->getSiteUrl($directory);
224-
225-
if (! $site) {
226-
throw new DomainException(
227-
sprintf(
228-
"The [%s] site could not be found in Valet's site list.",
229-
$directory
230-
)
231-
);
232-
}
194+
if (!$site = $this->site->getSiteUrl($directory)) {
195+
throw new DomainException("The [{$directory}] site could not be found in Valet's site list.");
196+
}
233197

234-
if ($version == 'default') { // Remove isolation for this site
235-
$oldCustomPhpVersion = $this->site->customPhpVersion($site); // Example output: "74"
236-
$this->site->removeIsolation($site);
237-
$this->stopIfUnused($oldCustomPhpVersion);
238-
$this->nginx->restart();
239-
info(sprintf('The site [%s] is now using the default PHP version.', $site));
198+
$this->brew->ensureInstalled($version, [], $this->taps);
240199

241-
return;
242-
}
200+
$oldCustomPhpVersion = $this->site->customPhpVersion($site); // Example output: "74"
201+
$this->createConfigurationFiles($version);
202+
203+
$this->site->isolate($site, $this->fpmSockName($version), $version);
204+
205+
$this->stopIfUnused($oldCustomPhpVersion);
206+
$this->restart($version);
207+
$this->nginx->restart();
208+
209+
info(sprintf('The site [%s] is now using %s.', $site, $version));
210+
}
211+
212+
/**
213+
* Remove PHP version isolation for a given directory
214+
*
215+
* @param string $directory
216+
* @return void
217+
*/
218+
public function unIsolateDirectory($directory)
219+
{
220+
$site = $this->site->getSiteUrl($directory);
221+
222+
if (!$site) {
223+
throw new DomainException(
224+
sprintf(
225+
"The [%s] site could not be found in Valet's site list.",
226+
$directory
227+
)
228+
);
243229
}
244230

231+
$oldCustomPhpVersion = $this->site->customPhpVersion($site); // Example output: "74"
232+
233+
$this->site->removeIsolation($site);
234+
$this->stopIfUnused($oldCustomPhpVersion);
235+
$this->nginx->restart();
236+
237+
info(sprintf('The site [%s] is now using the default PHP version.', $site));
238+
}
239+
240+
/**
241+
* Use a specific version of PHP globally.
242+
*
243+
* @param string $version
244+
* @param bool $force
245+
* @return string|void
246+
*/
247+
public function useVersion($version, $force = false)
248+
{
245249
$version = $this->validateRequestedVersion($version);
246250

247251
try {
@@ -253,31 +257,14 @@ public function useVersion($version, $force = false, $directory = null)
253257
} catch (DomainException $e) { /* ignore thrown exception when no linked php is found */
254258
}
255259

256-
if (! $this->brew->installed($version)) {
257-
// Install the relevant formula if not already installed
258-
$this->brew->ensureInstalled($version, [], $this->taps);
259-
}
260-
261-
if ($directory) {
262-
$oldCustomPhpVersion = $this->site->customPhpVersion($site); // Example output: "74"
263-
$this->cli->quietly('sudo rm '.VALET_HOME_PATH.'/'.$this->fpmSockName($version));
264-
$this->updateConfiguration($version);
265-
$this->site->installSiteConfig($site, $this->fpmSockName($version), $version);
266-
267-
$this->stopIfUnused($oldCustomPhpVersion);
268-
$this->restart($version);
269-
$this->nginx->restart();
270-
info(sprintf('The site [%s] is now using %s.', $site, $version));
271-
272-
return;
273-
}
260+
$this->brew->ensureInstalled($version, [], $this->taps);
274261

275262
// Unlink the current global PHP if there is one installed
276263
if ($this->brew->hasLinkedPhp()) {
277264
$linkedPhp = $this->brew->linkedPhp();
278265

279266
// Update the old FPM to keep running, using a custom sock file, so existing isolated sites aren't broken
280-
$this->updateConfiguration($linkedPhp);
267+
$this->createConfigurationFiles($linkedPhp);
281268

282269
// Update existing custom Nginx config files; if they're using the old or new PHP version,
283270
// update them to the new correct sock file location
@@ -297,7 +284,6 @@ public function useVersion($version, $force = false, $directory = null)
297284
$this->files->unlink(VALET_HOME_PATH.'/valet.sock');
298285
$this->cli->quietly('sudo rm '.VALET_HOME_PATH.'/valet*.sock');
299286

300-
// ensure configuration is correct and start the linked version
301287
$this->install();
302288

303289
$newVersion = $version === 'php' ? $this->brew->determineAliasedVersion($version) : $version;
@@ -311,41 +297,37 @@ public function useVersion($version, $force = false, $directory = null)
311297
}
312298

313299
/**
314-
* If passed php7.4 or php74 formats, normalize to [email protected] format.
300+
* If passed php7.4, or php74, 7.4, or 74 formats, normalize to [email protected] format.
315301
*/
316302
public function normalizePhpVersion($version)
317303
{
304+
// @todo There's probably a way to incorporate this into the regex
305+
if (strpos($version, 'php') === false) {
306+
$version = 'php' . $version;
307+
}
308+
318309
return preg_replace('/(php)([0-9+])(?:.)?([0-9+])/i', '$1@$2.$3', $version);
319310
}
320311

321312
/**
322313
* Validate the requested version to be sure we can support it.
323314
*
324-
* @param $version
315+
* @param string $version
325316
* @return string
326317
*/
327318
public function validateRequestedVersion($version)
328319
{
329320
$version = $this->normalizePhpVersion($version);
330321

331322
if (! $this->brew->supportedPhpVersions()->contains($version)) {
332-
throw new DomainException(
333-
sprintf(
334-
'Valet doesn\'t support PHP version: %s (try something like \'[email protected]\' instead)',
335-
$version
336-
)
337-
);
323+
throw new DomainException("Valet doesn't support PHP version: {$version} (try something like '[email protected]' instead)");
338324
}
339325

340326
if (strpos($aliasedVersion = $this->brew->determineAliasedVersion($version), '@')) {
341327
return $aliasedVersion;
342328
}
343329

344330
if ($version === 'php') {
345-
if (strpos($aliasedVersion = $this->brew->determineAliasedVersion($version), '@')) {
346-
return $aliasedVersion;
347-
}
348-
349331
if ($this->brew->hasInstalledPhp()) {
350332
throw new DomainException('Brew is already using PHP '.PHP_VERSION.' as \'php\' in Homebrew. To use another version, please specify. eg: [email protected]');
351333
}

‎cli/Valet/Site.php

+3-2
Original file line numberDiff line numberDiff line change
@@ -704,9 +704,10 @@ public function buildSecureNginxServer($url, $siteConf = null)
704704
* @param string $phpVersion
705705
* @return void
706706
*/
707-
public function installSiteConfig($valetSite, $fpmSockName, $phpVersion)
707+
public function isolate($valetSite, $fpmSockName, $phpVersion)
708708
{
709709
if ($this->files->exists($this->nginxPath($valetSite))) {
710+
// Modify the existing config if it exists (likely because it's secured)
710711
$siteConf = $this->files->get($this->nginxPath($valetSite));
711712
$siteConf = $this->replaceSockFile($siteConf, $fpmSockName, $phpVersion);
712713
} else {
@@ -768,7 +769,7 @@ public function unsecure($url)
768769

769770
// If the user had isolated the PHP version for this site, swap out .sock file
770771
if ($phpVersion) {
771-
$this->installSiteConfig($url, "valet{$phpVersion}.sock", $phpVersion);
772+
$this->isolate($url, "valet{$phpVersion}.sock", $phpVersion);
772773
}
773774
}
774775

‎cli/includes/compatibility.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
exit(1);
1717
}
1818

19-
if (version_compare(PHP_VERSION, '5.6.0', '<')) {
20-
echo 'Valet requires PHP 5.6 or later.';
19+
if (version_compare(PHP_VERSION, '7.0', '<')) {
20+
echo 'Valet requires PHP 7.0 or later.';
2121

2222
exit(1);
2323
}

0 commit comments

Comments
 (0)