Dotenv.php
8.88 KB
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
<?php
/**
* Dotenv.
*
* Loads a `.env` file in the given directory and sets the environment vars.
*/
class Dotenv
{
/**
* If true, then environment variables will not be overwritten.
*
* @var bool
*/
protected static $immutable = true;
/**
* Load `.env` file in given directory.
*
* @param string $path
* @param string $file
*
* @return void
*/
public static function load($path, $file = '.env')
{
if (!is_string($file)) {
$file = '.env';
}
$filePath = rtrim($path, '/').'/'.$file;
if (!is_readable($filePath) || !is_file($filePath)) {
throw new \InvalidArgumentException(
sprintf(
'Dotenv: Environment file %s not found or not readable. '.
'Create file with your environment settings at %s',
$file,
$filePath
)
);
}
// Read file into an array of lines with auto-detected line endings
$autodetect = ini_get('auto_detect_line_endings');
ini_set('auto_detect_line_endings', '1');
$lines = file($filePath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
ini_set('auto_detect_line_endings', $autodetect);
foreach ($lines as $line) {
// Disregard comments
if (strpos(trim($line), '#') === 0) {
continue;
}
// Only use non-empty lines that look like setters
if (strpos($line, '=') !== false) {
static::setEnvironmentVariable($line);
}
}
}
/**
* Set a variable.
*
* Variable set using:
* - putenv
* - $_ENV
* - $_SERVER.
*
* The environment variable value is stripped of single and double quotes.
*
* @param string $name
* @param string|null $value
*
* @return void
*/
public static function setEnvironmentVariable($name, $value = null)
{
list($name, $value) = static::normaliseEnvironmentVariable($name, $value);
// Don't overwrite existing environment variables if we're immutable
// Ruby's dotenv does this with `ENV[key] ||= value`.
if (static::$immutable === true && !is_null(static::findEnvironmentVariable($name))) {
return;
}
putenv("$name=$value");
$_ENV[$name] = $value;
$_SERVER[$name] = $value;
}
/**
* Require specified ENV vars to be present, or throw an exception.
*
* You can also pass through an set of allowed values for the environment variable.
*
* @param mixed $environmentVariables
* @param string[] $allowedValues
*
* @throws \RuntimeException
*
* @return true
*/
public static function required($environmentVariables, array $allowedValues = array())
{
$environmentVariables = (array) $environmentVariables;
$missingEnvironmentVariables = array();
foreach ($environmentVariables as $environmentVariable) {
$value = static::findEnvironmentVariable($environmentVariable);
if (is_null($value)) {
$missingEnvironmentVariables[] = $environmentVariable;
} elseif ($allowedValues) {
if (!in_array($value, $allowedValues)) {
// may differentiate in the future, but for now this does the job
$missingEnvironmentVariables[] = $environmentVariable;
}
}
}
if ($missingEnvironmentVariables) {
throw new \RuntimeException(
sprintf(
"Required environment variable missing, or value not allowed: '%s'",
implode("', '", $missingEnvironmentVariables)
)
);
}
return true;
}
/**
* Takes value as passed in by developer.
*
* We're also:
* - ensuring we're dealing with a separate name and value, breaking apart the name string if needed
* - cleaning the value of quotes
* - cleaning the name of quotes
* - resolving nested variables
*
* @param string $name
* @param string $value
*
* @return array
*/
protected static function normaliseEnvironmentVariable($name, $value)
{
list($name, $value) = static::splitCompoundStringIntoParts($name, $value);
$name = static::sanitiseVariableName($name);
$value = static::sanitiseVariableValue($value);
$value = static::resolveNestedVariables($value);
return array($name, $value);
}
/**
* If the $name contains an = sign, then we split it into 2 parts, a name & value.
*
* @param string $name
* @param string $value
*
* @return array
*/
protected static function splitCompoundStringIntoParts($name, $value)
{
if (strpos($name, '=') !== false) {
list($name, $value) = array_map('trim', explode('=', $name, 2));
}
return array($name, $value);
}
/**
* Strips quotes from the environment variable value.
*
* @param string $value
*
* @return string
*/
protected static function sanitiseVariableValue($value)
{
$value = trim($value);
if (!$value) {
return '';
}
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 = $parts[0];
}
return trim($value);
}
/**
* Strips quotes and the optional leading "export " from the environment variable name.
*
* @param string $name
*
* @return string
*/
protected static function sanitiseVariableName($name)
{
return trim(str_replace(array('export ', '\'', '"'), '', $name));
}
/**
* Look for {$varname} patterns in the variable value.
*
* Replace with an existing environment variable.
*
* @param string $value
*
* @return mixed
*/
protected static function resolveNestedVariables($value)
{
if (strpos($value, '$') !== false) {
$value = preg_replace_callback(
'/{\$([a-zA-Z0-9_]+)}/',
function ($matchedPatterns) {
$nestedVariable = Dotenv::findEnvironmentVariable($matchedPatterns[1]);
if (is_null($nestedVariable)) {
return $matchedPatterns[0];
} else {
return $nestedVariable;
}
},
$value
);
}
return $value;
}
/**
* Search the different places for environment variables and return first value found.
*
* @param string $name
*
* @return string
*/
public static function findEnvironmentVariable($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);
return $value === false ? null : $value; // switch getenv default to null
}
}
/**
* Check Dotenv immutable status.
*
* Returns true if immutable, false if mutable.
*
* @return bool
*/
public static function isImmutable()
{
return static::$immutable;
}
/**
* Make Dotenv immutable.
*
* This means that once set, an environment variable cannot be overridden.
*
* @return void
*/
public static function makeImmutable()
{
static::$immutable = true;
}
/**
* Make Dotenv mutable.
*
* Environment variables will act as, well, variables.
*
* @return void
*/
public static function makeMutable()
{
static::$immutable = false;
}
}