[Dotenv] load .env.local.php and define APP_DEBUG

nicolas-grekas · nicolas-grekas · commit 19cd11ca36cb · 2020-01-11T18:07:41.000+01:00
diff --git a/UPGRADE-5.1.md b/UPGRADE-5.1.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 5.0 to 5.1
 =======================
 
+Dotenv
+------
+
+ * Deprecated passing `$usePutenv` argument to Dotenv's constructor, use `Dotenv::usePutenv()` instead.
+
 EventDispatcher
 ---------------
 
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 5.x to 6.0
 =======================
 
+Dotenv
+------
+
+ * Removed argument `$usePutenv` from Dotenv's constructor, use `Dotenv::usePutenv()` instead.
+
 EventDispatcher
 ---------------
 
diff --git a/src/Symfony/Bridge/PhpUnit/composer.json b/src/Symfony/Bridge/PhpUnit/composer.json
@@ -24,7 +24,8 @@
         "symfony/error-handler": "For tracking deprecated interfaces usages at runtime with DebugClassLoader"
     },
     "conflict": {
-        "phpunit/phpunit": "<5.4.3"
+        "phpunit/phpunit": "<5.4.3",
+        "symfony/dotenv": "<5.1"
     },
     "autoload": {
         "files": [ "bootstrap.php" ],
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Secrets/DotenvVaultTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Secrets/DotenvVaultTest.php
@@ -38,7 +38,7 @@ public function testEncryptAndDecrypt()
         $vault->seal('foo', $plain);
 
         unset($_SERVER['foo'], $_ENV['foo']);
-        (new Dotenv(false))->load($this->envFile);
+        (new Dotenv())->load($this->envFile);
 
         $decrypted = $vault->reveal('foo');
         $this->assertSame($plain, $decrypted);
@@ -50,7 +50,7 @@ public function testEncryptAndDecrypt()
         $this->assertFalse($vault->remove('foo'));
 
         unset($_SERVER['foo'], $_ENV['foo']);
-        (new Dotenv(false))->load($this->envFile);
+        (new Dotenv())->load($this->envFile);
 
         $this->assertArrayNotHasKey('foo', $vault->list());
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -37,7 +37,7 @@
         "symfony/console": "^4.4|^5.0",
         "symfony/css-selector": "^4.4|^5.0",
         "symfony/dom-crawler": "^4.4|^5.0",
-        "symfony/dotenv": "^4.4|^5.0",
+        "symfony/dotenv": "^5.1",
         "symfony/polyfill-intl-icu": "~1.0",
         "symfony/form": "^4.4|^5.0",
         "symfony/expression-language": "^4.4|^5.0",
@@ -71,7 +71,7 @@
         "symfony/asset": "<4.4",
         "symfony/browser-kit": "<4.4",
         "symfony/console": "<4.4",
-        "symfony/dotenv": "<4.4",
+        "symfony/dotenv": "<5.1",
         "symfony/dom-crawler": "<4.4",
         "symfony/http-client": "<4.4",
         "symfony/form": "<4.4",
diff --git a/src/Symfony/Component/Console/composer.json b/src/Symfony/Component/Console/composer.json
@@ -41,6 +41,7 @@
     },
     "conflict": {
         "symfony/dependency-injection": "<4.4",
+        "symfony/dotenv": "<5.1",
         "symfony/event-dispatcher": "<4.4",
         "symfony/lock": "<4.4",
         "symfony/process": "<4.4"
diff --git a/src/Symfony/Component/Dotenv/CHANGELOG.md b/src/Symfony/Component/Dotenv/CHANGELOG.md
@@ -1,6 +1,15 @@
 CHANGELOG
 =========
 
+5.1.0
+-----
+
+ * added `Dotenv::setProdEnvs()` and `Dotenv::usePutenv()`
+ * made `Dotenv::loadEnv()` check for `env.local.php`
+ * made Dotenv's constructor to accept `$envKey` and `$debugKey` arguments, to define
+   the name of the env vars that configure the env name and debug settings
+ * deprecated passing `$usePutenv` argument to Dotenv's constructor
+
 5.0.0
 -----
 
diff --git a/src/Symfony/Component/Dotenv/Dotenv.php b/src/Symfony/Component/Dotenv/Dotenv.php
@@ -35,15 +35,47 @@ final class Dotenv
     private $data;
     private $end;
     private $values;
-    private $usePutenv;
+    private $envKey;
+    private $debugKey;
+    private $prodEnvs = ['prod'];
+    private $usePutenv = false;
 
     /**
-     * @var bool If `putenv()` should be used to define environment variables or not.
-     *           Beware that `putenv()` is not thread safe, that's why this setting defaults to false
+     * @param string|null $envKey
      */
-    public function __construct(bool $usePutenv = false)
+    public function __construct($envKey = null, string $debugKey = null)
+    {
+        if (null !== $envKey && \in_array($envKey = (string) $envKey, ['1', ''], true)) {
+            @trigger_error(sprintf('Passing a boolean to the constructor of "%s" is deprecated since Symfony 5.1, use "Dotenv::usePutenv()".', __CLASS__), E_USER_DEPRECATED);
+            $this->usePutenv = (bool) $envKey;
+            $envKey = null;
+        }
+
+        $this->envKey = $envKey;
+        $this->debugKey = $debugKey;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setProdEnvs(array $prodEnvs): self
+    {
+        $this->prodEnvs = $prodEnvs;
+
+        return $this;
+    }
+
+    /**
+     * @param bool $usePutenv If `putenv()` should be used to define environment variables or not.
+     *                        Beware that `putenv()` is not thread safe, that's why this setting defaults to false
+     *
+     * @return $this
+     */
+    public function usePutenv($usePutenv = true): self
     {
         $this->usePutenv = $usePutenv;
+
+        return $this;
     }
 
     /**
@@ -67,32 +99,43 @@ public function load(string $path, string ...$extraPaths): void
      * .env.dist is loaded when it exists and .env is not found.
      *
      * @param string $path       A file to load
-     * @param string $varName    The name of the env vars that defines the app env
+     * @param string $envKey     The name of the env vars that defines the app env
      * @param string $defaultEnv The app env to use when none is defined
      * @param array  $testEnvs   A list of app envs for which .env.local should be ignored
      *
      * @throws FormatException when a file has a syntax error
      * @throws PathException   when a file does not exist or is not readable
      */
-    public function loadEnv(string $path, string $varName = 'APP_ENV', string $defaultEnv = 'dev', array $testEnvs = ['test']): void
+    public function loadEnv(string $path, string $envKey = 'APP_ENV', string $defaultEnv = 'dev', array $testEnvs = ['test']): void
     {
+        $envKey = null === $this->envKey || 1 < \func_num_args() ? $envKey : $this->envKey;
+
+        $p = $path.'.local.php';
+        $env = (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($p)) || file_exists($p) ? include $p : null;
+
+        if (\is_array($env) && ($_SERVER[$envKey] ?? $_ENV[$envKey] ?? $env[$envKey] ?? null) === ($env[$envKey] ?? null)) {
+            $this->populate($env);
+            $env = $env[$envKey] ?? $defaultEnv;
+            goto configure_debug;
+        }
+
         if (file_exists($path) || !file_exists($p = "$path.dist")) {
             $this->load($path);
         } else {
             $this->load($p);
         }
 
-        if (null === $env = $_SERVER[$varName] ?? $_ENV[$varName] ?? null) {
-            $this->populate([$varName => $env = $defaultEnv]);
+        if (null === $env = $_SERVER[$envKey] ?? $_ENV[$envKey] ?? null) {
+            $this->populate([$envKey => $env = $defaultEnv]);
         }
 
         if (!\in_array($env, $testEnvs, true) && file_exists($p = "$path.local")) {
             $this->load($p);
-            $env = $_SERVER[$varName] ?? $_ENV[$varName] ?? $env;
+            $env = $_SERVER[$envKey] ?? $_ENV[$envKey] ?? $env;
         }
 
         if ('local' === $env) {
-            return;
+            goto configure_debug;
         }
 
         if (file_exists($p = "$path.$env")) {
@@ -102,6 +145,14 @@ public function loadEnv(string $path, string $varName = 'APP_ENV', string $defau
         if (file_exists($p = "$path.$env.local")) {
             $this->load($p);
         }
+
+        configure_debug:
+        if (null !== $debugKey = $this->debugKey) {
+            $debug = $_SERVER[$debugKey] ?? $_ENV[$debugKey] ?? !\in_array($env, $this->prodEnvs);
+            $_ENV[$debugKey] = (int) $debug || filter_var($debug, FILTER_VALIDATE_BOOLEAN) ? '1' : '0';
+        }
+
+        $_SERVER += $_ENV;
     }
 
     /**
diff --git a/src/Symfony/Component/Dotenv/Tests/DotenvTest.php b/src/Symfony/Component/Dotenv/Tests/DotenvTest.php
