Add enforceDomain() method. (#15)

Author: davereid

README.md

@@ -87,6 +87,11 @@ elseif (Environment::isLocal()) {
   // Set some development environment settings overrides.
 }
 
+// Redirect any internal platform domains to a preferred domain.
+if (Environment::isProduction()) {
+  Environment::enforceDomain('www.example.com');
+}
+
 // Include a environment-specific settings file.
 if ($environment = Environment::getEnvironment()) {
   $settings_file = 'settings.' . $environment . '.php';

src/Environment.php

@@ -180,4 +180,64 @@ public static function getComposerLockFilename(): string
         $filename = static::getComposerFilename();
         return pathinfo($filename, PATHINFO_FILENAME) . '.lock';
     }
+
+    /**
+     * Get the current host name.
+     *
+     * @return string
+     *   The current host name.
+     */
+    public static function getHost(): string
+    {
+        static $host;
+        if (!isset($host)) {
+            $possibleHostSources = array('HTTP_X_FORWARDED_HOST', 'HTTP_HOST', 'SERVER_NAME', 'SERVER_ADDR');
+            $sourceTransformations = array(
+                "HTTP_X_FORWARDED_HOST" => function ($value) {
+                    $elements = explode(',', $value);
+                    return trim(end($elements));
+                }
+            );
+            $host = '';
+            foreach ($possibleHostSources as $source) {
+                if (!empty($host)) {
+                    break;
+                }
+                if (empty($_SERVER[$source])) {
+                    continue;
+                }
+                $host = $_SERVER[$source];
+                if (array_key_exists($source, $sourceTransformations)) {
+                    $host = $sourceTransformations[$source]($host);
+                }
+            }
+
+            // trim and remove port number from host
+            // host is lowercase as per RFC 952/2181
+            $host = strtolower(preg_replace('/:\d+$/', '', trim($host)));
+        }
+        return $host;
+    }
+
+    /**
+     * Redirect requests to a preferred domain.
+     *
+     * This will not redirect CLI requests.
+     *
+     * @param string $domain
+     *   The preferred domain name.
+     */
+    public static function enforceDomain(string $domain): void
+    {
+        if (!static::isCli() && static::getHost() !== $domain) {
+            // Name transaction "redirect" in New Relic for improved reporting.
+            if (extension_loaded('newrelic')) {
+                newrelic_name_transaction('redirect');
+            }
+
+            header('HTTP/1.0 301 Moved Permanently');
+            header('Location: https://' . $domain . $_SERVER['REQUEST_URI']);
+            exit();
+        }
+    }
 }

src/Pantheon.php

@@ -65,6 +65,6 @@ public static function isMultidev(): bool
      */
     public static function isCustomDomain(): bool
     {
-        return isset($_SERVER['HTTP_HOST']) && !str_ends_with($_SERVER['HTTP_HOST'], static::PLATFORM_DOMAIN);
+        return !str_ends_with(Environment::getHost(), static::PLATFORM_DOMAIN);
     }
 }

tests/src/EnvironmentTest.php

@@ -173,7 +173,8 @@ public static function providerEnvironment(): array
                         'PANTHEON_ENVIRONMENT' => 'live',
                     ],
                     '_SERVER' => [
-                        'HTTP_HOST' => 'www.example.com',
+                        'HTTP_X_FORWARDED_HOST' => 'www.example.com',
+                        'HTTP_HOST' => 'drupal-environment-live.pantheonsite.io',
                     ],
                 ],
                 [
@@ -192,6 +193,7 @@ public static function providerEnvironment(): array
                     'isCustomDomain' => true,
                     'isCi' => false,
                     'isLocal' => false,
+                    'getHost' => 'www.example.com',
                     'getIndicatorConfig' => [
                         'name' => 'Production',
                         'bg_color' => '#e7131a',
@@ -205,7 +207,7 @@ public static function providerEnvironment(): array
                         'PANTHEON_ENVIRONMENT' => 'test',
                     ],
                     '_SERVER' => [
-                        'HTTP_HOST' => 'drupal-environment-test.pantheonsite.io',
+                        'HTTP_X_FORWARDED_HOST' => 'drupal-environment-test.pantheonsite.io',
                     ],
                 ],
                 [
@@ -224,6 +226,7 @@ public static function providerEnvironment(): array
                     'isCustomDomain' => false,
                     'isCi' => false,
                     'isLocal' => false,
+                    'getHost' => 'drupal-environment-test.pantheonsite.io',
                     'getIndicatorConfig' => [
                         'name' => 'Staging',
                         'bg_color' => '#b85c00',
@@ -256,6 +259,7 @@ public static function providerEnvironment(): array
                     'isCustomDomain' => false,
                     'isCi' => false,
                     'isLocal' => false,
+                    'getHost' => 'drupal-environment-dev.pantheonsite.io',
                     'getIndicatorConfig' => [
                         'name' => 'Development',
                         'bg_color' => '#307b24',
@@ -288,6 +292,7 @@ public static function providerEnvironment(): array
                     'isCustomDomain' => false,
                     'isCi' => false,
                     'isLocal' => false,
+                    'getHost' => 'drupal-environment-multidev-test.pantheonsite.io',
                     'getIndicatorConfig' => [
                         'name' => 'Preview',
                         'bg_color' => '#20688C',
@@ -511,7 +516,31 @@ public static function providerEnvironment(): array
                     'getComposerFilename' => 'alternate.ext',
                     'getComposerLockFilename' => 'alternate.lock',
                 ]
-            ]
+            ],
+            'current-domain-servername' => [
+                [
+                    '_SERVER' => [
+                        'SERVER_NAME' => 'www.SERVERNAME.com:443',
+                        'SERVER_ADDR' => '127.0.0.1:80',
+                    ],
+                ],
+                [
+                    'getHost' => 'www.servername.com',
+                ],
+            ],
+            'current-domain-serveraddr' => [
+                [
+                    '_SERVER' => [
+                        'HTTP_X_FORWARDED_HOST' => '',
+                        'HTTP_HOST' => '',
+                        'SERVER_NAME' => '',
+                        'SERVER_ADDR' => '127.0.0.1:80',
+                    ],
+                ],
+                [
+                    'getHost' => '127.0.0.1',
+                ],
+            ],
         ];
     }
 }