-
Notifications
You must be signed in to change notification settings - Fork 2
/
EnvConfig.php
326 lines (268 loc) · 8.77 KB
/
EnvConfig.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
326
<?php
declare(strict_types=1);
namespace Inpsyde\App;
use Inpsyde\App\Location\GenericLocations;
use Inpsyde\App\Location\Locations;
use Inpsyde\App\Location\VipLocations;
use Inpsyde\App\Location\WpEngineLocations;
class EnvConfig implements SiteConfig
{
public const FILTER_ENV_NAME = 'wp-app.environment';
public const LOCAL = 'local';
public const DEVELOPMENT = 'development';
public const PRODUCTION = 'production';
public const STAGING = 'staging';
private const ENV_ALIASES = [
'local' => self::LOCAL,
'development' => self::DEVELOPMENT,
'dev' => self::DEVELOPMENT,
'develop' => self::DEVELOPMENT,
'staging' => self::STAGING,
'stage' => self::STAGING,
'preprod' => self::STAGING,
'pre-prod' => self::STAGING,
'pre-production' => self::STAGING,
'test' => self::STAGING,
'uat' => self::STAGING,
'production' => self::PRODUCTION,
'prod' => self::PRODUCTION,
'live' => self::PRODUCTION,
];
private const HOSTING_LOCATIONS_CLASS_MAP = [
self::HOSTING_WPE => WpEngineLocations::class,
self::HOSTING_VIP => VipLocations::class,
self::HOSTING_SPACES => GenericLocations::class,
self::HOSTING_OTHER => GenericLocations::class,
];
/**
* @var string
*/
private $env = '';
/**
* @var array<string, mixed>
*/
private $data = [];
/**
* @var string[]
*/
private $namespaces = [];
/**
* @var Locations|null
*/
private $locations;
/**
* @var string
*/
private $hosting = '';
/**
* @param string ...$namespaces
*/
public function __construct(string ...$namespaces)
{
foreach ($namespaces as $namespace) {
$trimmed = $namespace ? trim($namespace, '\\') : null;
$trimmed and $this->namespaces[] = $trimmed;
}
}
/**
* @return Locations
*/
public function locations(): Locations
{
if ($this->locations instanceof Locations) {
return $this->locations;
}
$locationClassName = self::HOSTING_LOCATIONS_CLASS_MAP[$this->hosting()] ?? '';
if (
!$locationClassName
|| !class_exists($locationClassName)
|| !is_subclass_of($locationClassName, Locations::class)
) {
$locationClassName = GenericLocations::class;
}
/** @var callable $factory */
$factory = [$locationClassName, 'createFromConfig'];
/** @var Locations $locations */
$locations = $factory($this);
$this->locations = $locations;
return $this->locations;
}
/**
* @return string
*/
public function hosting(): string
{
if ($this->hosting) {
return $this->hosting;
}
$hosting = $this->get('HOSTING');
if ($hosting && is_string($hosting)) {
$this->hosting = $hosting;
return $this->hosting;
}
if ($this->get('VIP_GO_ENV') !== null) {
$this->hosting = self::HOSTING_VIP;
return $this->hosting;
}
if (function_exists('is_wpe')) {
$this->hosting = self::HOSTING_WPE;
return $this->hosting;
}
if ($this->get('SPACES_SPACE_ID')) {
$this->hosting = self::HOSTING_SPACES;
return $this->hosting;
}
$this->hosting = self::HOSTING_OTHER;
return $this->hosting;
}
/**
* @param string $hosting
* @return bool
*/
public function hostingIs(string $hosting): bool
{
return strtolower($this->hosting()) === strtolower($hosting);
}
/**
* @return string
*
* phpcs:disable Generic.Metrics.CyclomaticComplexity
*/
public function env(): string
{
// phpcs:enable Generic.Metrics.CyclomaticComplexity
if ($this->env) {
return $this->env;
}
// Use WP function if we can (WP 5.5+).
$env = function_exists('wp_get_environment_type') ? wp_get_environment_type() : null;
$env = $env
?? $this->readEnvVarOrConstant('WP_ENVIRONMENT_TYPE') // WP core
?? $this->readEnvVarOrConstant('WP_ENV') // WP Starter or Bedrock
?? $this->readEnvVarOrConstant('WORDPRESS_ENV') // WP Starter legacy
?? $this->readEnvVarOrConstant('VIP_GO_APP_ENVIRONMENT') // VIP Go
?? $this->readEnvVarOrConstant('VIP_GO_ENV'); // VIP Go legacy
if ($env) {
return $this->normalizeEnv((string)$env, false);
}
if (function_exists('is_wpe')) { // WP Engine legacy
$env = ((int)is_wpe()) > 0 ? self::PRODUCTION : self::STAGING;
$this->env = $this->normalizeEnv($env, true);
return $this->env;
}
/** @psalm-suppress TypeDoesNotContainType */
$env = (defined('WP_DEBUG') && WP_DEBUG) ? self::DEVELOPMENT : self::PRODUCTION;
$this->env = $this->normalizeEnv($env, true);
return $this->env;
}
/**
* @param string $env
* @return bool
*/
public function envIs(string $env): bool
{
$env = strtolower($env);
if (array_key_exists($env, self::ENV_ALIASES)) {
$env = self::ENV_ALIASES[$env];
}
return $this->env() === $env;
}
/**
* @param string $name
* @param null $default
* @return mixed|null
*
* phpcs:disable Inpsyde.CodeQuality.ReturnTypeDeclaration
* phpcs:disable Inpsyde.CodeQuality.ArgumentTypeDeclaration
* @psalm-suppress MissingReturnType
* @psalm-suppress MissingParamType
*/
public function get(string $name, $default = null)
{
// phpcs:enable Inpsyde.CodeQuality.ReturnTypeDeclaration
// phpcs:enable Inpsyde.CodeQuality.ArgumentTypeDeclaration
if (!$name) {
return $default;
}
if (array_key_exists($name, $this->data)) {
return $this->data[$name];
}
// Try namespaced constant
foreach ($this->namespaces as $namespace) {
if (defined("\\{$namespace}\\{$name}")) {
$this->data[$name] = constant("\\{$namespace}\\{$name}");
return $this->data[$name];
}
}
// Try env var or global constant
$env = $this->readEnvVarOrConstant($name);
if ($env !== null) {
$this->data[$name] = $env;
return $env;
}
$this->data[$name] = $default;
return $default;
}
/**
* @return array{env:string, hosting:string, keys:array<string>}
*/
#[\ReturnTypeWillChange]
public function jsonSerialize(): array
{
return [
'env' => $this->env(),
'hosting' => $this->hosting(),
'keys' => array_keys($this->data),
];
}
/**
* @param string $name
* @return mixed
*
* phpcs:disable Inpsyde.CodeQuality.ReturnTypeDeclaration
* @psalm-suppress MissingReturnType
*/
private function readEnvVarOrConstant(string $name)
{
// phpcs:enable
if (defined($name)) {
return constant($name);
}
$value = $_ENV[$name] ?? null;
if ($value === null && stripos($name, 'HTTP_') !== 0) {
$value = $_SERVER[$name] ?? null; // phpcs:ignore
}
if ($value === null && (PHP_SAPI === 'cli' || PHP_SAPI === 'cli-server')) {
$value = getenv($name) ?: null;
}
return $value;
}
/**
* Ensures the environment is one of the four supported, to ensure it matches what
* `wp_get_environment_type()` will return.
* When we were not able to determine environment unequivocally we use `apply_filters` to that
* There's one more chance for developers to define the env.
* Even in that case the environment will be normalized to one of the supported environments,
* in the worst case with a fallback to production, just like WP 5.5+ does.
*
* @param string $env
* @param bool $applyFilters
* @return string
*/
private function normalizeEnv(string $env, bool $applyFilters): string
{
$lower = strtolower($env);
// When we are going to apply_filters we don't want to fallback to production already,
// we'll do later, if needed.
$default = $applyFilters ? $lower : self::PRODUCTION;
$env = self::ENV_ALIASES[$lower] ?? $default;
if (!$applyFilters) {
return $env;
}
$filtered = apply_filters(self::FILTER_ENV_NAME, $env);
if ($filtered && is_string($filtered)) {
$env = strtolower($filtered);
}
return self::ENV_ALIASES[$env] ?? self::PRODUCTION;
}
}