vendor/symfony/dependency-injection/EnvVarProcessor.php line 172

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\DependencyInjection;
  14. use Symfony\Component\DependencyInjection\Exception\EnvNotFoundException;
  15. use Symfony\Component\DependencyInjection\Exception\ParameterCircularReferenceException;
  16. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  18. /**
  19.  * @author Nicolas Grekas <p@tchwork.com>
  20.  */
  21. class EnvVarProcessor implements EnvVarProcessorInterface
  22. {
  23.     private $container;
  24.     private \Traversable $loaders;
  25.     private array $loadedVars = [];
  27.     /**
  28.      * @param EnvVarLoaderInterface[] $loaders
  29.      */
  30.     public function __construct(ContainerInterface $container, \Traversable $loaders = null)
  31.     {
  32.         $this->container = $container;
  33.         $this->loaders = $loaders ?? new \ArrayIterator();
  34.     }
  36.     /**
  37.      * {@inheritdoc}
  38.      */
  39.     public static function getProvidedTypes(): array
  40.     {
  41.         return [
  42.             'base64' => 'string',
  43.             'bool' => 'bool',
  44.             'not' => 'bool',
  45.             'const' => 'bool|int|float|string|array',
  46.             'csv' => 'array',
  47.             'file' => 'string',
  48.             'float' => 'float',
  49.             'int' => 'int',
  50.             'json' => 'array',
  51.             'key' => 'bool|int|float|string|array',
  52.             'url' => 'array',
  53.             'query_string' => 'array',
  54.             'resolve' => 'string',
  55.             'default' => 'bool|int|float|string|array',
  56.             'string' => 'string',
  57.             'trim' => 'string',
  58.             'require' => 'bool|int|float|string|array',
  59.         ];
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function getEnv(string $prefix, string $name, \Closure $getEnv): mixed
  66.     {
  67.         $i = strpos($name, ':');
  69.         if ('key' === $prefix) {
  70.             if (false === $i) {
  71.                 throw new RuntimeException(sprintf('Invalid env "key:%s": a key specifier should be provided.', $name));
  72.             }
  74.             $next = substr($name, $i + 1);
  75.             $key = substr($name, 0, $i);
  76.             $array = $getEnv($next);
  78.             if (!\is_array($array)) {
  79.                 throw new RuntimeException(sprintf('Resolved value of "%s" did not result in an array value.', $next));
  80.             }
  82.             if (!isset($array[$key]) && !\array_key_exists($key, $array)) {
  83.                 throw new EnvNotFoundException(sprintf('Key "%s" not found in %s (resolved from "%s").', $key, json_encode($array), $next));
  84.             }
  86.             return $array[$key];
  87.         }
  89.         if ('default' === $prefix) {
  90.             if (false === $i) {
  91.                 throw new RuntimeException(sprintf('Invalid env "default:%s": a fallback parameter should be provided.', $name));
  92.             }
  94.             $next = substr($name, $i + 1);
  95.             $default = substr($name, 0, $i);
  97.             if ('' !== $default && !$this->container->hasParameter($default)) {
  98.                 throw new RuntimeException(sprintf('Invalid env fallback in "default:%s": parameter "%s" not found.', $name, $default));
  99.             }
  101.             try {
  102.                 $env = $getEnv($next);
  104.                 if ('' !== $env && null !== $env) {
  105.                     return $env;
  106.                 }
  107.             } catch (EnvNotFoundException $e) {
  108.                 // no-op
  109.             }
  111.             return '' === $default ? null : $this->container->getParameter($default);
  112.         }
  114.         if ('file' === $prefix || 'require' === $prefix) {
  115.             if (!is_scalar($file = $getEnv($name))) {
  116.                 throw new RuntimeException(sprintf('Invalid file name: env var "%s" is non-scalar.', $name));
  117.             }
  118.             if (!is_file($file)) {
  119.                 throw new EnvNotFoundException(sprintf('File "%s" not found (resolved from "%s").', $file, $name));
  120.             }
  122.             if ('file' === $prefix) {
  123.                 return file_get_contents($file);
  124.             } else {
  125.                 return require $file;
  126.             }
  127.         }
  129.         if (false !== $i || 'string' !== $prefix) {
  130.             $env = $getEnv($name);
  131.         } elseif (isset($_ENV[$name])) {
  132.             $env = $_ENV[$name];
  133.         } elseif (isset($_SERVER[$name]) && !str_starts_with($name, 'HTTP_')) {
  134.             $env = $_SERVER[$name];
  135.         } elseif (false === ($env = getenv($name)) || null === $env) { // null is a possible value because of thread safety issues
  136.             foreach ($this->loadedVars as $vars) {
  137.                 if (false !== $env = ($vars[$name] ?? false)) {
  138.                     break;
  139.                 }
  140.             }
  142.             if (false === $env || null === $env) {
  143.                 $loaders = $this->loaders;
  144.                 $this->loaders = new \ArrayIterator();
  146.                 try {
  147.                     $i = 0;
  148.                     $ended = true;
  149.                     $count = $loaders instanceof \Countable ? $loaders->count() : 0;
  150.                     foreach ($loaders as $loader) {
  151.                         if (\count($this->loadedVars) > $i++) {
  152.                             continue;
  153.                         }
  154.                         $this->loadedVars[] = $vars = $loader->loadEnvVars();
  155.                         if (false !== $env = $vars[$name] ?? false) {
  156.                             $ended = false;
  157.                             break;
  158.                         }
  159.                     }
  160.                     if ($ended || $count === $i) {
  161.                         $loaders = $this->loaders;
  162.                     }
  163.                 } catch (ParameterCircularReferenceException $e) {
  164.                     // skip loaders that need an env var that is not defined
  165.                 } finally {
  166.                     $this->loaders = $loaders;
  167.                 }
  168.             }
  170.             if (false === $env || null === $env) {
  171.                 if (!$this->container->hasParameter("env($name)")) {
  172.                     throw new EnvNotFoundException(sprintf('Environment variable not found: "%s".', $name));
  173.                 }
  175.                 $env = $this->container->getParameter("env($name)");
  176.             }
  177.         }
  179.         if (null === $env) {
  180.             if (!isset($this->getProvidedTypes()[$prefix])) {
  181.                 throw new RuntimeException(sprintf('Unsupported env var prefix "%s".', $prefix));
  182.             }
  184.             return null;
  185.         }
  187.         if (!is_scalar($env)) {
  188.             throw new RuntimeException(sprintf('Non-scalar env var "%s" cannot be cast to "%s".', $name, $prefix));
  189.         }
  191.         if ('string' === $prefix) {
  192.             return (string) $env;
  193.         }
  195.         if (\in_array($prefix, ['bool', 'not'], true)) {
  196.             $env = (bool) (filter_var($env, \FILTER_VALIDATE_BOOLEAN) ?: filter_var($env, \FILTER_VALIDATE_INT) ?: filter_var($env, \FILTER_VALIDATE_FLOAT));
  198.             return 'not' === $prefix ? !$env : $env;
  199.         }
  201.         if ('int' === $prefix) {
  202.             if (false === $env = filter_var($env, \FILTER_VALIDATE_INT) ?: filter_var($env, \FILTER_VALIDATE_FLOAT)) {
  203.                 throw new RuntimeException(sprintf('Non-numeric env var "%s" cannot be cast to int.', $name));
  204.             }
  206.             return (int) $env;
  207.         }
  209.         if ('float' === $prefix) {
  210.             if (false === $env = filter_var($env, \FILTER_VALIDATE_FLOAT)) {
  211.                 throw new RuntimeException(sprintf('Non-numeric env var "%s" cannot be cast to float.', $name));
  212.             }
  214.             return (float) $env;
  215.         }
  217.         if ('const' === $prefix) {
  218.             if (!\defined($env)) {
  219.                 throw new RuntimeException(sprintf('Env var "%s" maps to undefined constant "%s".', $name, $env));
  220.             }
  222.             return \constant($env);
  223.         }
  225.         if ('base64' === $prefix) {
  226.             return base64_decode(strtr($env, '-_', '+/'));
  227.         }
  229.         if ('json' === $prefix) {
  230.             $env = json_decode($env, true);
  232.             if (\JSON_ERROR_NONE !== json_last_error()) {
  233.                 throw new RuntimeException(sprintf('Invalid JSON in env var "%s": ', $name).json_last_error_msg());
  234.             }
  236.             if (null !== $env && !\is_array($env)) {
  237.                 throw new RuntimeException(sprintf('Invalid JSON env var "%s": array or null expected, "%s" given.', $name, get_debug_type($env)));
  238.             }
  240.             return $env;
  241.         }
  243.         if ('url' === $prefix) {
  244.             $parsedEnv = parse_url($env);
  246.             if (false === $parsedEnv) {
  247.                 throw new RuntimeException(sprintf('Invalid URL in env var "%s".', $name));
  248.             }
  249.             if (!isset($parsedEnv['scheme'], $parsedEnv['host'])) {
  250.                 throw new RuntimeException(sprintf('Invalid URL env var "%s": schema and host expected, "%s" given.', $name, $env));
  251.             }
  252.             $parsedEnv += [
  253.                 'port' => null,
  254.                 'user' => null,
  255.                 'pass' => null,
  256.                 'path' => null,
  257.                 'query' => null,
  258.                 'fragment' => null,
  259.             ];
  261.             // remove the '/' separator
  262.             $parsedEnv['path'] = '/' === ($parsedEnv['path'] ?? '/') ? '' : substr($parsedEnv['path'], 1);
  264.             return $parsedEnv;
  265.         }
  267.         if ('query_string' === $prefix) {
  268.             $queryString = parse_url($env, \PHP_URL_QUERY) ?: $env;
  269.             parse_str($queryString, $result);
  271.             return $result;
  272.         }
  274.         if ('resolve' === $prefix) {
  275.             return preg_replace_callback('/%%|%([^%\s]+)%/', function ($match) use ($name, $getEnv) {
  276.                 if (!isset($match[1])) {
  277.                     return '%';
  278.                 }
  280.                 if (str_starts_with($match[1], 'env(') && str_ends_with($match[1], ')') && 'env()' !== $match[1]) {
  281.                     $value = $getEnv(substr($match[1], 4, -1));
  282.                 } else {
  283.                     $value = $this->container->getParameter($match[1]);
  284.                 }
  286.                 if (!is_scalar($value)) {
  287.                     throw new RuntimeException(sprintf('Parameter "%s" found when resolving env var "%s" must be scalar, "%s" given.', $match[1], $name, get_debug_type($value)));
  288.                 }
  290.                 return $value;
  291.             }, $env);
  292.         }
  294.         if ('csv' === $prefix) {
  295.             return str_getcsv($env, ',', '"', '');
  296.         }
  298.         if ('trim' === $prefix) {
  299.             return trim($env);
  300.         }
  302.         throw new RuntimeException(sprintf('Unsupported env var prefix "%s" for env name "%s".', $prefix, $name));
  303.     }
  304. }