Move server helpers to their own file; add type hints

2026-02-07 01:00:09 +01:00 · 2022-12-15 21:34:48 -06:00
parent b2b0e1d592
commit 29b94a48a6
4 changed files with 163 additions and 147 deletions
--- a/cli/includes/server-helpers.php
+++ b/cli/includes/server-helpers.php
@@ -0,0 +1,144 @@
+<?php
+
+/**
+ * Show the Valet 404 "Not Found" page.
+ */
+function show_valet_404()
+{
+    http_response_code(404);
+    require __DIR__ . '/cli/templates/404.html';
+    exit;
+}
+
+/**
+ * Show directory listing or 404 if directory doesn't exist.
+ *
+ * @param  string  $valetSitePath
+ * @param  string  $uri
+ */
+function show_directory_listing(string $valetSitePath, string $uri)
+{
+    $is_root = ($uri == '/');
+    $directory = ($is_root) ? $valetSitePath : $valetSitePath . $uri;
+
+    if (!file_exists($directory)) {
+        show_valet_404();
+    }
+
+    // Sort directories at the top
+    $paths = glob("$directory/*");
+    usort($paths, function ($a, $b) {
+        return (is_dir($a) == is_dir($b)) ? strnatcasecmp($a, $b) : (is_dir($a) ? -1 : 1);
+    });
+
+    // Output the HTML for the directory listing
+    echo "<h1>Index of $uri</h1>";
+    echo '<hr>';
+    echo implode("<br>\n", array_map(function ($path) use ($uri, $is_root) {
+        $file = basename($path);
+
+        return ($is_root) ? "<a href='/$file'>/$file</a>" : "<a href='$uri/$file'>$uri/$file/</a>";
+    }, $paths));
+
+    exit;
+}
+
+/**
+ * You may use wildcard DNS provider nip.io as a tool for testing your site via an IP address.
+ * First, determine the IP address of your local computer (like 192.168.0.10).
+ * Then, visit http://project.your-ip.nip.io - e.g.: http://laravel.192.168.0.10.nip.io.
+ *
+ * @param  string  $domain
+ * @param  array  $valetConfig
+ * @return  string
+ */
+function valet_support_wildcard_dns(string $domain, array $valetConfig): string
+{
+    $services = [
+        '.*.*.*.*.nip.io',
+        '-*-*-*-*.nip.io',
+    ];
+
+    if (isset($valetConfig['tunnel_services'])) {
+        $services = array_merge($services, (array) $valetConfig['tunnel_services']);
+    }
+
+    $patterns = [];
+    foreach ($services as $service) {
+        $pattern = preg_quote($service, '#');
+        $pattern = str_replace('\*', '.*', $pattern);
+        $patterns[] = '(.*)' . $pattern;
+    }
+
+    $pattern = implode('|', $patterns);
+
+    if (preg_match('#(?:' . $pattern . ')\z#u', $domain, $matches)) {
+        $domain = array_pop($matches);
+    }
+
+    if (strpos($domain, ':') !== false) {
+        $domain = explode(':', $domain)[0];
+    }
+
+    return $domain;
+}
+
+/**
+ * @param  array  $valetConfig  Valet configuration array
+ * @return string|null If set, default site path for uncaught urls
+ **/
+function valet_default_site_path(array $valetConfig): ?string
+{
+    if (isset($valetConfig['default']) && is_string($valetConfig['default']) && is_dir($valetConfig['default'])) {
+        return $valetConfig['default'];
+    }
+}
+
+/**
+ * Determine the fully qualified path to the site.
+ * Inspects registered path directories, case-sensitive.
+ *
+ * @param  array   $valetConfig
+ * @param  string  $siteName
+ * @param  string  $domain
+ * @return string
+ */
+function get_valet_site_path(array $valetConfig, string $siteName, string $domain): string
+{
+    $valetSitePath = null;
+
+    foreach ($valetConfig['paths'] as $path) {
+        $handle = opendir($path);
+
+        if ($handle === false) {
+            continue;
+        }
+
+        $dirs = [];
+
+        while (false !== ($file = readdir($handle))) {
+            if (is_dir($path . '/' . $file) && !in_array($file, ['.', '..'])) {
+                $dirs[] = $file;
+            }
+        }
+
+        closedir($handle);
+
+        // Note: strtolower used below because Nginx only tells us lowercase names
+        foreach ($dirs as $dir) {
+            if (strtolower($dir) === $siteName) {
+                // early return when exact match for linked subdomain
+                return $path . '/' . $dir;
+            }
+
+            if (strtolower($dir) === $domain) {
+                // no early return here because the foreach may still have some subdomains to process with higher priority
+                $valetSitePath = $path . '/' . $dir;
+            }
+        }
+
+        if ($valetSitePath) {
+            return $valetSitePath;
+        }
+    }
+}