pgleadershipbook
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
pgleadershipbook / trunk / system / Config / DotEnv.php
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\Config; /** * Environment-specific configuration */ class DotEnv { /** * The directory where the .env file can be located. * * @var string */ protected $path; //-------------------------------------------------------------------- /** * Builds the path to our file. * * @param string $path * @param string $file */ public function __construct(string $path, string $file = '.env') { $this->path = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $file; } //-------------------------------------------------------------------- /** * The main entry point, will load the .env file and process it * so that we end up with all settings in the PHP environment vars * (i.e. getenv(), $_ENV, and $_SERVER) * * @return boolean */ public function load(): bool { $vars = $this->parse(); return ($vars === null ? false : true); } //-------------------------------------------------------------------- /** * Parse the .env file into an array of key => value * * @return array|null */ public function parse(): ?array { // We don't want to enforce the presence of a .env file, they should be optional. if (! is_file($this->path)) { return null; } // Ensure the file is readable if (! is_readable($this->path)) { throw new \InvalidArgumentException("The .env file is not readable: {$this->path}"); } $vars = []; $lines = file($this->path, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES); foreach ($lines as $line) { // Is it a comment? if (strpos(trim($line), '#') === 0) { continue; } // If there is an equal sign, then we know we are assigning a variable. if (strpos($line, '=') !== false) { list($name, $value) = $this->normaliseVariable($line); $vars[$name] = $value; $this->setVariable($name, $value); } } return $vars; } //-------------------------------------------------------------------- /** * Sets the variable into the environment. Will parse the string * first to look for {name}={value} pattern, ensure that nested * variables are handled, and strip it of single and double quotes. * * @param string $name * @param string $value */ protected function setVariable(string $name, string $value = '') { if (! getenv($name, true)) { putenv("$name=$value"); } if (empty($_ENV[$name])) { $_ENV[$name] = $value; } if (empty($_SERVER[$name])) { $_SERVER[$name] = $value; } } //-------------------------------------------------------------------- /** * Parses for assignment, cleans the $name and $value, and ensures * that nested variables are handled. * * @param string $name * @param string $value * * @return array */ public function normaliseVariable(string $name, string $value = ''): array { // 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 $name = str_replace(['export', '\'', '"'], '', $name); // Sanitize the value $value = $this->sanitizeValue($value); $value = $this->resolveNestedVariables($value); // Handle hex2bin prefix if ($name === 'encryption.key' && strpos($value, 'hex2bin:') === 0) { $value = hex2bin(substr($value, 8)); } 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 $value * * @return string * @throws \InvalidArgumentException */ protected function sanitizeValue(string $value): string { if (! $value) { return $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 $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 $value * * @return string */ protected function resolveNestedVariables(string $value): string { if (strpos($value, '$') !== false) { $loader = $this; $value = preg_replace_callback( '/\${([a-zA-Z0-9_]+)}/', 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]; case array_key_exists($name, $_SERVER): return $_SERVER[$name]; default: $value = getenv($name); // switch getenv default to null return $value === false ? null : $value; } } //-------------------------------------------------------------------- } |
Commits for pgleadershipbook/trunk/system/Config/DotEnv.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Thu 04 Feb, 2021 09:33:04 +0000 | PG Leadership book initial commit |