1
0
mirror of https://github.com/laravel/valet.git synced 2026-02-04 08:10:07 +01:00

wip valet 3 custom drivers fix

This commit is contained in:
Matt Stauffer
2023-02-01 17:09:24 -05:00
parent dd8e15edf5
commit d4032f111e
3 changed files with 237 additions and 1 deletions

View File

@@ -31,6 +31,7 @@ abstract public function frontControllerPath(string $sitePath, string $siteName,
*/
public static function assign(string $sitePath, string $siteName, string $uri): ?ValetDriver
{
// @todo: If any Valet 3 drivers (without the right method signature) still exist, halt and warn
$drivers = [];
// Queue custom driver based on path

View File

@@ -0,0 +1,234 @@
<?php
namespace Valet\Drivers;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use RecursiveRegexIterator;
use RegexIterator;
/**
* This is here only for existing custom drivers to extend when users first upgrade to Valet 4.
*/
abstract class ValetDriver
{
/**
* Determine if the driver serves the request.
*
* @param string $sitePath
* @param string $siteName
* @param string $uri
* @return bool
*/
abstract public function serves($sitePath, $siteName, $uri);
/**
* Determine if the incoming request is for a static file.
*
* @param string $sitePath
* @param string $siteName
* @param string $uri
* @return string|false
*/
abstract public function isStaticFile($sitePath, $siteName, $uri);
/**
* Get the fully resolved path to the application's front controller.
*
* @param string $sitePath
* @param string $siteName
* @param string $uri
* @return string
*/
abstract public function frontControllerPath($sitePath, $siteName, $uri);
/**
* Find a driver that can serve the incoming request.
*
* @param string $sitePath
* @param string $siteName
* @param string $uri
* @return ValetDriver|null
*/
public static function assign($sitePath, $siteName, $uri)
{
$drivers = [];
if ($customSiteDriver = static::customSiteDriver($sitePath)) {
$drivers[] = $customSiteDriver;
}
$drivers = array_merge($drivers, static::driversIn(VALET_HOME_PATH.'/Drivers'));
$drivers[] = 'LaravelValetDriver';
$drivers[] = 'WordPressValetDriver';
$drivers[] = 'BedrockValetDriver';
$drivers[] = 'ContaoValetDriver';
$drivers[] = 'SymfonyValetDriver';
$drivers[] = 'CraftValetDriver';
$drivers[] = 'StatamicValetDriver';
$drivers[] = 'StatamicV1ValetDriver';
$drivers[] = 'CakeValetDriver';
$drivers[] = 'SculpinValetDriver';
$drivers[] = 'JigsawValetDriver';
$drivers[] = 'KirbyValetDriver';
$drivers[] = 'KatanaValetDriver';
$drivers[] = 'JoomlaValetDriver';
$drivers[] = 'DrupalValetDriver';
$drivers[] = 'Concrete5ValetDriver';
$drivers[] = 'Typo3ValetDriver';
$drivers[] = 'NeosValetDriver';
$drivers[] = 'Magento2ValetDriver';
$drivers[] = 'BasicValetDriver';
foreach ($drivers as $driver) {
try {
// Try for old, un-namespaced drivers
$driver = new $driver;
} catch (\Throwable $e) {
$className = "Valet\Drivers\\$driver";
$driver = new $className;
}
if ($driver->serves($sitePath, $siteName, $driver->mutateUri($uri))) {
return $driver;
}
}
}
/**
* Get the custom driver class from the site path, if one exists.
*
* @param string $sitePath
* @return string
*/
public static function customSiteDriver($sitePath)
{
if (! file_exists($sitePath.'/LocalValetDriver.php')) {
return;
}
require_once $sitePath.'/LocalValetDriver.php';
return 'LocalValetDriver';
}
/**
* Get all of the driver classes in a given path.
*
* @param string $path
* @return array
*/
public static function driversIn($path)
{
if (! is_dir($path)) {
return [];
}
$drivers = [];
$dir = new RecursiveDirectoryIterator($path);
$iterator = new RecursiveIteratorIterator($dir);
$regex = new RegexIterator($iterator, '/^.+ValetDriver\.php$/i', RecursiveRegexIterator::GET_MATCH);
foreach ($regex as $file) {
require_once $file[0];
$drivers[] = basename($file[0], '.php');
}
return $drivers;
}
/**
* Mutate the incoming URI.
*
* @param string $uri
* @return string
*/
public function mutateUri($uri)
{
return $uri;
}
/**
* Serve the static file at the given path.
*
* @param string $staticFilePath
* @param string $sitePath
* @param string $siteName
* @param string $uri
* @return void
*/
public function serveStaticFile($staticFilePath, $sitePath, $siteName, $uri)
{
/**
* Back story...
*
* PHP docs *claim* you can set default_mimetype = "" to disable the default
* Content-Type header. This works in PHP 7+, but in PHP 5.* it sends an
* *empty* Content-Type header, which is significantly different than
* sending *no* Content-Type header.
*
* However, if you explicitly set a Content-Type header, then explicitly
* remove that Content-Type header, PHP seems to not re-add the default.
*
* I have a hard time believing this is by design and not coincidence.
*
* Burn. it. all.
*/
header('Content-Type: text/html');
header_remove('Content-Type');
header('X-Accel-Redirect: /'.VALET_STATIC_PREFIX.$staticFilePath);
}
/**
* Determine if the path is a file and not a directory.
*
* @param string $path
* @return bool
*/
protected function isActualFile($path)
{
return ! is_dir($path) && file_exists($path);
}
/**
* Load server environment variables if available.
* Processes any '*' entries first, and then adds site-specific entries.
*
* @param string $sitePath
* @param string $siteName
* @return void
*/
public function loadServerEnvironmentVariables($sitePath, $siteName)
{
$varFilePath = $sitePath.'/.valet-env.php';
if (! file_exists($varFilePath)) {
$varFilePath = VALET_HOME_PATH.'/.valet-env.php';
}
if (! file_exists($varFilePath)) {
return;
}
$variables = include $varFilePath;
$variablesToSet = isset($variables['*']) ? $variables['*'] : [];
if (isset($variables[$siteName])) {
$variablesToSet = array_merge($variablesToSet, $variables[$siteName]);
}
foreach ($variablesToSet as $key => $value) {
if (! is_string($key)) {
continue;
}
$_SERVER[$key] = $value;
$_ENV[$key] = $value;
putenv($key.'='.$value);
}
}
}

View File

@@ -21,7 +21,8 @@
"files": [
"cli/includes/compatibility.php",
"cli/includes/facades.php",
"cli/includes/helpers.php"
"cli/includes/helpers.php",
"cli/includes/Valet3Driver.php"
],
"psr-4": {
"Valet\\": "cli/Valet/"