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

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 $loaders;
  25.     private $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()
  40.     {
  41.         return [
  42.             'base64' => 'string',
  43.             'bool' => 'bool',
  44.             'const' => 'bool|int|float|string|array',
  45.             'csv' => 'array',
  46.             'file' => 'string',
  47.             'float' => 'float',
  48.             'int' => 'int',
  49.             'json' => 'array',
  50.             'key' => 'bool|int|float|string|array',
  51.             'url' => 'array',
  52.             'query_string' => 'array',
  53.             'resolve' => 'string',
  54.             'default' => 'bool|int|float|string|array',
  55.             'string' => 'string',
  56.             'trim' => 'string',
  57.             'require' => 'bool|int|float|string|array',
  58.         ];
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function getEnv($prefix, $name, \Closure $getEnv)
  65.     {
  66.         $i = strpos($name, ':');
  68.         if ('key' === $prefix) {
  69.             if (false === $i) {
  70.                 throw new RuntimeException(sprintf('Invalid env "key:%s": a key specifier should be provided.', $name));
  71.             }
  73.             $next = substr($name, $i + 1);
  74.             $key = substr($name, 0, $i);
  75.             $array = $getEnv($next);
  77.             if (!\is_array($array)) {
  78.                 throw new RuntimeException(sprintf('Resolved value of "%s" did not result in an array value.', $next));
  79.             }
  81.             if (!isset($array[$key]) && !\array_key_exists($key, $array)) {
  82.                 throw new EnvNotFoundException(sprintf('Key "%s" not found in "%s" (resolved from "%s").', $key, json_encode($array), $next));
  83.             }
  85.             return $array[$key];
  86.         }
  88.         if ('default' === $prefix) {
  89.             if (false === $i) {
  90.                 throw new RuntimeException(sprintf('Invalid env "default:%s": a fallback parameter should be provided.', $name));
  91.             }
  93.             $next = substr($name, $i + 1);
  94.             $default = substr($name, 0, $i);
  96.             if ('' !== $default && !$this->container->hasParameter($default)) {
  97.                 throw new RuntimeException(sprintf('Invalid env fallback in "default:%s": parameter "%s" not found.', $name, $default));
  98.             }
  100.             try {
  101.                 $env = $getEnv($next);
  103.                 if ('' !== $env && null !== $env) {
  104.                     return $env;
  105.                 }
  106.             } catch (EnvNotFoundException $e) {
  107.                 // no-op
  108.             }
  110.             return '' === $default ? null : $this->container->getParameter($default);
  111.         }
  113.         if ('file' === $prefix || 'require' === $prefix) {
  114.             if (!is_scalar($file = $getEnv($name))) {
  115.                 throw new RuntimeException(sprintf('Invalid file name: env var "%s" is non-scalar.', $name));
  116.             }
  117.             if (!file_exists($file)) {
  118.                 throw new EnvNotFoundException(sprintf('File "%s" not found (resolved from "%s").', $file, $name));
  119.             }
  121.             if ('file' === $prefix) {
  122.                 return file_get_contents($file);
  123.             } else {
  124.                 return require $file;
  125.             }
  126.         }
  128.         if (false !== $i || 'string' !== $prefix) {
  129.             $env = $getEnv($name);
  130.         } elseif (isset($_ENV[$name])) {
  131.             $env = $_ENV[$name];
  132.         } elseif (isset($_SERVER[$name]) && 0 !== strpos($name, 'HTTP_')) {
  133.             $env = $_SERVER[$name];
  134.         } elseif (false === ($env = getenv($name)) || null === $env) { // null is a possible value because of thread safety issues
  135.             foreach ($this->loadedVars as $vars) {
  136.                 if (false !== $env = ($vars[$name] ?? false)) {
  137.                     break;
  138.                 }
  139.             }
  141.             if (false === $env || null === $env) {
  142.                 $loaders = $this->loaders;
  143.                 $this->loaders = new \ArrayIterator();
  145.                 try {
  146.                     $i = 0;
  147.                     $ended = true;
  148.                     $count = $loaders instanceof \Countable ? $loaders->count() : 0;
  149.                     foreach ($loaders as $loader) {
  150.                         if (\count($this->loadedVars) > $i++) {
  151.                             continue;
  152.                         }
  153.                         $this->loadedVars[] = $vars = $loader->loadEnvVars();
  154.                         if (false !== $env = $vars[$name] ?? false) {
  155.                             $ended = false;
  156.                             break;
  157.                         }
  158.                     }
  159.                     if ($ended || $count === $i) {
  160.                         $loaders = $this->loaders;
  161.                     }
  162.                 } catch (ParameterCircularReferenceException $e) {
  163.                     // skip loaders that need an env var that is not defined
  164.                 } finally {
  165.                     $this->loaders = $loaders;
  166.                 }
  167.             }
  169.             if (false === $env || null === $env) {
  170.                 if (!$this->container->hasParameter("env($name)")) {
  171.                     throw new EnvNotFoundException(sprintf('Environment variable not found: "%s".', $name));
  172.                 }
  174.                 $env = $this->container->getParameter("env($name)");
  175.             }
  176.         }
  178.         if (null === $env) {
  179.             if (!isset($this->getProvidedTypes()[$prefix])) {
  180.                 throw new RuntimeException(sprintf('Unsupported env var prefix "%s".', $prefix));
  181.             }
  183.             return null;
  184.         }
  186.         if (!is_scalar($env)) {
  187.             throw new RuntimeException(sprintf('Non-scalar env var "%s" cannot be cast to "%s".', $name, $prefix));
  188.         }
  190.         if ('string' === $prefix) {
  191.             return (string) $env;
  192.         }
  194.         if ('bool' === $prefix) {
  195.             return (bool) (filter_var($env, \FILTER_VALIDATE_BOOLEAN) ?: filter_var($env, \FILTER_VALIDATE_INT) ?: filter_var($env, \FILTER_VALIDATE_FLOAT));
  196.         }
  198.         if ('int' === $prefix) {
  199.             if (false === $env = filter_var($env, \FILTER_VALIDATE_INT) ?: filter_var($env, \FILTER_VALIDATE_FLOAT)) {
  200.                 throw new RuntimeException(sprintf('Non-numeric env var "%s" cannot be cast to int.', $name));
  201.             }
  203.             return (int) $env;
  204.         }
  206.         if ('float' === $prefix) {
  207.             if (false === $env = filter_var($env, \FILTER_VALIDATE_FLOAT)) {
  208.                 throw new RuntimeException(sprintf('Non-numeric env var "%s" cannot be cast to float.', $name));
  209.             }
  211.             return (float) $env;
  212.         }
  214.         if ('const' === $prefix) {
  215.             if (!\defined($env)) {
  216.                 throw new RuntimeException(sprintf('Env var "%s" maps to undefined constant "%s".', $name, $env));
  217.             }
  219.             return \constant($env);
  220.         }
  222.         if ('base64' === $prefix) {
  223.             return base64_decode(strtr($env, '-_', '+/'));
  224.         }
  226.         if ('json' === $prefix) {
  227.             $env = json_decode($env, true);
  229.             if (\JSON_ERROR_NONE !== json_last_error()) {
  230.                 throw new RuntimeException(sprintf('Invalid JSON in env var "%s": ', $name).json_last_error_msg());
  231.             }
  233.             if (null !== $env && !\is_array($env)) {
  234.                 throw new RuntimeException(sprintf('Invalid JSON env var "%s": array or null expected, "%s" given.', $name, \gettype($env)));
  235.             }
  237.             return $env;
  238.         }
  240.         if ('url' === $prefix) {
  241.             $parsedEnv = parse_url($env);
  243.             if (false === $parsedEnv) {
  244.                 throw new RuntimeException(sprintf('Invalid URL in env var "%s".', $name));
  245.             }
  246.             if (!isset($parsedEnv['scheme'], $parsedEnv['host'])) {
  247.                 throw new RuntimeException(sprintf('Invalid URL env var "%s": schema and host expected, "%s" given.', $name, $env));
  248.             }
  249.             $parsedEnv += [
  250.                 'port' => null,
  251.                 'user' => null,
  252.                 'pass' => null,
  253.                 'path' => null,
  254.                 'query' => null,
  255.                 'fragment' => null,
  256.             ];
  258.             if (null !== $parsedEnv['path']) {
  259.                 // remove the '/' separator
  260.                 $parsedEnv['path'] = '/' === $parsedEnv['path'] ? null : substr($parsedEnv['path'], 1);
  261.             }
  263.             return $parsedEnv;
  264.         }
  266.         if ('query_string' === $prefix) {
  267.             $queryString = parse_url($env, \PHP_URL_QUERY) ?: $env;
  268.             parse_str($queryString, $result);
  270.             return $result;
  271.         }
  273.         if ('resolve' === $prefix) {
  274.             return preg_replace_callback('/%%|%([^%\s]+)%/', function ($match) use ($name) {
  275.                 if (!isset($match[1])) {
  276.                     return '%';
  277.                 }
  278.                 $value = $this->container->getParameter($match[1]);
  279.                 if (!is_scalar($value)) {
  280.                     throw new RuntimeException(sprintf('Parameter "%s" found when resolving env var "%s" must be scalar, "%s" given.', $match[1], $name, \gettype($value)));
  281.                 }
  283.                 return $value;
  284.             }, $env);
  285.         }
  287.         if ('csv' === $prefix) {
  288.             return str_getcsv($env, ',', '"', \PHP_VERSION_ID >= 70400 ? '' : '\\');
  289.         }
  291.         if ('trim' === $prefix) {
  292.             return trim($env);
  293.         }
  295.         throw new RuntimeException(sprintf('Unsupported env var prefix "%s".', $prefix));
  296.     }
  297. }