Dotenv::filePath() - Code Metrics - Inspection of "Merge branch 'master' into 0.7.0" - lenevor/syscodes - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 0.7.0 ( 7cf8ff...8cbd21 )

by Alexander
created 2021-01-28 14:02 UTC
Dotenv::filePath() A

↳ Parent: Dotenv::create()
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
<?php 

/**
 * Lenevor Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file license.md.
 * It is also available through the world-wide-web at this URL:
 * https://lenevor.com/license
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to [email protected] so we can send you a copy immediately.
 *
 * @package     Lenevor
 * @subpackage  Base
 * @link        https://lenevor.com
 * @copyright   Copyright (c) 2019 - 2021 Alexander Campo <[email protected]>
 * @license     https://opensource.org/licenses/BSD-3-Clause New BSD license or see https://lenevor.com/license or see /license.md
 */

namespace Syscodes\Dotenv;

use InvalidArgumentException;
use Syscodes\Dotenv\Store\StoreBuilder;
use Syscodes\Dotenv\Repository\RepositoryCreator;

/**
 * Manages .env files.
 * 
 * @author Alexander Campo <[email protected]>
 */
final class Dotenv
{
    protected const ALFANUMERIC_REGEX = '/\${([a-zA-Z0-9_]+)}/';

    /**
     * The loader instance.
     * 
     * @var \Syscodes\Dotenv\Loader\Loader $loader
     */
    protected $loader;

    /**
     * The Parser instance.
     * 
     * @var \Syscodes\Dotenv\Loader\Parser $parser
     */
    protected $parser;

    /**
     * The Repository creator instance.
     * 
     * @var \Syscodes\Dotenv\Repository\RepositoryCreator $repository
     */
    protected $repository;

    /**
     * The file store instance.
     * 
     * @var \Syscodes\Dotenv\Repository\FileStore $store
filter:
    dependency_paths: ["lib/*"]
     */
    protected $store;

    /**
     * Activate use of putenv, by default is true.
     * 
     * @var bool $usePutenv 
     */
    protected $usePutenv = true;

    /**
     * Constructor. Create a new Dotenv instance.
     * 
     * @param  \Syscodes\Dotenv\Store\StoreBuilder  $store
     * @param  \Syscodes\Dotenv\Repository\RepositoryCreator  $repository
     * 
     * @return void
     */
    public function __construct($store, RepositoryCreator $repository)
    {
        $this->store      = $store;

        $this->repository = $repository;
    }

    /**
     * Create a new Dotenv instance.
     * Builds the path to our file.
     * 
     * @param  \Syscodes\Dotenv\Repository\RepositoryCreator  $repository
     * @param  string|string[]  $path
     * @param  string|string[]  $names
     * @param  bool  $modeEnabled  (true by default)
     * 
     * @return \Syscodes\Dotenv\Dotenv
     */
    public static function create(RepositoryCreator $repository, $paths, $names = null, bool $modeEnabled = true)
    {
        $store = $names === null ? StoreBuilder::createWithDefaultName() : StoreBuilder::createWithNoNames();

        foreach ((array) $paths as $path) {
            $store = $store->addPath($path);
        }
        
        foreach ((array) $names as $name) {
            $store = $store->addName($name);
        }

        if ($modeEnabled) {
            $store = $store->modeEnabled();
        }

        return new self($store->make(), $repository);
        return new self(/** @scrutinizer ignore-type */ $store->make(), $repository);
    }

    /**
     * Determine if the line in the file is a comment.
     * 
     * @param  string  $line
     * 
     * @return bool
     */
    protected function isComment(string $line)
    {
        return strpos(ltrim($line), '#') === 0;
    }

    /**
     * Determine if the given line looks like it's setting a variable.
     * 
     * @param  string  $line
     * 
     * @return bool
     */
    protected function checkedLikeSetter(string $line)
    {
        return strpos($line, '=') !== false;
    }

    /**
     * Will load the .env file and process it. So that we end all settings in the PHP 
     * environment vars: getenv(), $_ENV, and $_SERVER.
     * 
     * @return bool
     */
    public function load()
    {
        foreach ($this->store->read() as $line) {
            // Is it a comment?
            if ($this->isComment($line)) {
                continue;
            }

            // If there is an equal sign, then we know we
            // are assigning a variable.
            if ($this->checkedLikeSetter($line)) {
                $this->setVariable($line);
            }
        }

        return true;
    }

    /**
     * Sets the variable into the environment. 
     * Will parse the string to look for {name}={value} pattern.
     * 
     * @param  string  $name
     * @param  string|null  $value
     * 
     * @return void
     */
    protected function setVariable(string $name, $value = null)
    {
        list($name, $value) = $this->normaliseEnvironmentVariable($name, $value);
        
        $notHttpName = 0 !== strpos($name, 'HTTP_');

        if ($this->usePutenv) {
            putenv("$name=$value");
        }   
        
        if (empty($_ENV[$name])) {
            $_ENV[$name] = $value;
        }

        if ($notHttpName) {
            $_SERVER[$name] = $value;
        }
    }

    /**
     * Normalise the given environment variable.
     * 
     * @param  string  $name
     * @param  string  $value
     * 
     * @return array
     */
    public function normaliseEnvironmentVariable(string $name, $value)
    {
        // Split our compound string into it's parts.
        if (strpos($name, '=') !== false) {
            list($name, $value) = explode('=', $name, 2);
        }
        
        $name  = trim($name);
        $value = trim($value);
        
        // Sanitize the name
        list($name, $value) = $this->sanitizeName($name, $value);
        
        // Sanitize the value
        list($name, $value) = $this->sanitizeValue($name, $value);
        
        $value = $this->resolveNestedVariables($value);
        
        return [$name, $value];
    }

    /**
     * Strips quotes and the optional leading "export " from the environment variable name.
     * 
     * @param  string  $name
     * @param  string  $value
     * 
     * @return array
     */
    protected function sanitizeName(string $name, $value)
    {
        $name = str_replace(array('export ', '\'', '"'), '', $name);

        return [$name, $value];
    }

    /**
     * Strips quotes from the environment variable value.
     * 
     * This was borrowed from the excellent phpdotenv with very few changes.
     * https://github.com/vlucas/phpdotenv
     * 
     * @param  string  $name
     * @param  string  $value
     * 
     * @return array
     * 
     * @throws \InvalidArgumentException
     */
    protected function sanitizeValue(string $name, $value)
    {
        if ( ! $value) {
            return [$name, $value];
        }
        
        // Does it begin with a quote?
        if (strpbrk($value[0], '"\'') !== false) {
            // value starts with a quote
            $quote = $value[0];

            $regexPattern = sprintf(
					'/^
					%1$s          # match a quote at the start of the value
					(             # capturing sub-pattern used
								  (?:          # we do not need to capture this
								   [^%1$s\\\\] # any character other than a quote or backslash
								   |\\\\\\\\   # or two backslashes together
								   |\\\\%1$s   # or an escaped quote e.g \"
								  )*           # as many characters that match the previous rules
					)             # end of the capturing sub-pattern
					%1$s          # and the closing quote
					.*$           # and discard any string after the closing quote
					/mx', $quote
            );
            
            $value = preg_replace($regexPattern, '$1', $value);
            $value = str_replace("\\$quote", $quote, $value);
            $value = str_replace('\\\\', '\\', $value);
        } else {
            $parts = explode(' #', $value, 2);
            $value = trim($parts[0]);
            // Unquoted values cannot contain whitespace
            if (preg_match('/\s+/', $value) > 0) {
                throw new InvalidArgumentException('.env values containing spaces must be surrounded by quotes.');
            }
        }
        
        return [$name, $value];
    }
    
    /**
     * Resolve the nested variables.
     * 
     * Look for ${varname} patterns in the variable value and replace with an existing
     * environment variable.
     * 
     * This was borrowed from the excellent phpdotenv with very few changes.
     * https://github.com/vlucas/phpdotenv
     * 
     * @param  string  $value
     * 
     * @return string
     */
    protected function resolveNestedVariables(string $value)
    {
        if (strpos($value, '$') !== false) {
            $loader = $this;
            $value = preg_replace_callback(self::ALFANUMERIC_REGEX, function ($matchedPatterns) use ($loader) {
                
                $nestedVariable = $loader->getVariable($matchedPatterns[1]);

                if (is_null($nestedVariable)) {
                    return $matchedPatterns[0];
                }
                
                return $nestedVariable;
                
            }, $value);
        }
        
        return $value;
    }
    
    /**
     * Search the different places for environment variables and return first value found.
     * This was borrowed from the excellent phpdotenv with very few changes.
     * https://github.com/vlucas/phpdotenv
     * 
     * @param  string  $name
     * 
     * @return string|null
     */
    protected function getVariable(string $name)
    {
        switch (true) {
            case array_key_exists($name, $_ENV):
                return $_ENV[$name];
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case array_key_exists($name, $_SERVER):
                return $_SERVER[$name];
                break;
            default:
                $value = getenv($name);
                // switch getenv default to null
                return $value === false ? null : $value;
        }
    }
}
lenevor / syscodes

Push — 0.7.0 ( 7cf8ff...8cbd21 )

Dotenv::filePath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
