• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

nette / bootstrap / 15127772219

20 May 2025 02:52AM UTC coverage: 89.262% (-0.4%) from 89.655%
15127772219

push

github

dg
Configurator: updated to nette/assets v1

133 of 149 relevant lines covered (89.26%)

0.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.23
/src/Bootstrap/Configurator.php
1
<?php
2

3
/**
4
 * This file is part of the Nette Framework (https://nette.org)
5
 * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
6
 */
7

8
declare(strict_types=1);
9

10
namespace Nette\Bootstrap;
11

12
use Composer\Autoload\ClassLoader;
13
use Composer\InstalledVersions;
14
use Latte;
15
use Nette;
16
use Nette\DI;
17
use Nette\DI\Definitions\Statement;
18
use Tracy;
19

20

21
/**
22
 * Initial system DI container generator.
23
 */
24
class Configurator
25
{
26
        public const CookieSecret = 'nette-debug';
27

28
        /** @deprecated  use Configurator::CookieSecret */
29
        public const COOKIE_SECRET = self::CookieSecret;
30

31

32
        /** @var array<callable(self, DI\Compiler): void>  Occurs after the compiler is created */
33
        public array $onCompile = [];
34

35
        public array $defaultExtensions = [
36
                'application' => [Nette\Bridges\ApplicationDI\ApplicationExtension::class, ['%debugMode%', ['%appDir%'], '%tempDir%/cache/nette.application']],
37
                'assets' => [Nette\Bridges\Assets\DIExtension::class, ['%baseUrl%', '%wwwDir%', '%debugMode%']],
38
                'cache' => [Nette\Bridges\CacheDI\CacheExtension::class, ['%tempDir%/cache']],
39
                'constants' => Extensions\ConstantsExtension::class,
40
                'database' => [Nette\Bridges\DatabaseDI\DatabaseExtension::class, ['%debugMode%']],
41
                'decorator' => Nette\DI\Extensions\DecoratorExtension::class,
42
                'di' => [Nette\DI\Extensions\DIExtension::class, ['%debugMode%']],
43
                'extensions' => Nette\DI\Extensions\ExtensionsExtension::class,
44
                'forms' => Nette\Bridges\FormsDI\FormsExtension::class,
45
                'http' => [Nette\Bridges\HttpDI\HttpExtension::class, ['%consoleMode%']],
46
                'inject' => Nette\DI\Extensions\InjectExtension::class,
47
                'latte' => [Nette\Bridges\ApplicationDI\LatteExtension::class, ['%tempDir%/cache/latte', '%debugMode%']],
48
                'mail' => Nette\Bridges\MailDI\MailExtension::class,
49
                'php' => Extensions\PhpExtension::class,
50
                'routing' => [Nette\Bridges\ApplicationDI\RoutingExtension::class, ['%debugMode%']],
51
                'search' => [Nette\DI\Extensions\SearchExtension::class, ['%tempDir%/cache/nette.search']],
52
                'security' => [Nette\Bridges\SecurityDI\SecurityExtension::class, ['%debugMode%']],
53
                'session' => [Nette\Bridges\HttpDI\SessionExtension::class, ['%debugMode%', '%consoleMode%']],
54
                'tracy' => [Tracy\Bridges\Nette\TracyExtension::class, ['%debugMode%', '%consoleMode%']],
55
        ];
56

57
        /** @var string[] of classes which shouldn't be autowired */
58
        public array $autowireExcludedClasses = [
59
                \ArrayAccess::class,
60
                \Countable::class,
61
                \IteratorAggregate::class,
62
                \stdClass::class,
63
                \Traversable::class,
64
        ];
65

66
        protected array $staticParameters;
67
        protected array $dynamicParameters = [];
68
        protected array $services = [];
69

70
        /** @var array<string|array> */
71
        protected array $configs = [];
72

73

74
        public function __construct()
75
        {
76
                $this->staticParameters = $this->getDefaultParameters();
1✔
77

78
                if (class_exists(InstalledVersions::class) // back compatibility
1✔
79
                        && InstalledVersions::isInstalled('nette/caching')
1✔
80
                        && version_compare(InstalledVersions::getVersion('nette/caching'), '3.3.0', '<')
1✔
81
                ) {
82
                        $this->defaultExtensions['cache'][1][0] = '%tempDir%';
×
83
                }
84
        }
1✔
85

86

87
        /**
88
         * Set parameter %debugMode%.
89
         */
90
        public function setDebugMode(bool|string|array $value): static
1✔
91
        {
92
                if (is_string($value) || is_array($value)) {
1✔
93
                        $value = static::detectDebugMode($value);
1✔
94
                }
95

96
                $this->staticParameters['debugMode'] = $value;
1✔
97
                $this->staticParameters['productionMode'] = !$this->staticParameters['debugMode']; // compatibility
1✔
98
                return $this;
1✔
99
        }
100

101

102
        public function isDebugMode(): bool
103
        {
104
                return $this->staticParameters['debugMode'];
1✔
105
        }
106

107

108
        /**
109
         * Sets path to temporary directory.
110
         */
111
        public function setTempDirectory(string $path): static
1✔
112
        {
113
                $this->staticParameters['tempDir'] = $path;
1✔
114
                return $this;
1✔
115
        }
116

117

118
        /**
119
         * Sets the default timezone.
120
         */
121
        public function setTimeZone(string $timezone): static
1✔
122
        {
123
                date_default_timezone_set($timezone);
1✔
124
                @ini_set('date.timezone', $timezone); // @ - function may be disabled
1✔
125
                return $this;
1✔
126
        }
127

128

129
        /** @deprecated use addStaticParameters() */
130
        public function addParameters(array $params): static
1✔
131
        {
132
                return $this->addStaticParameters($params);
1✔
133
        }
134

135

136
        /**
137
         * Adds new static parameters.
138
         */
139
        public function addStaticParameters(array $params): static
1✔
140
        {
141
                $this->staticParameters = DI\Config\Helpers::merge($params, $this->staticParameters);
1✔
142
                return $this;
1✔
143
        }
144

145

146
        /**
147
         * Adds new dynamic parameters.
148
         */
149
        public function addDynamicParameters(array $params): static
1✔
150
        {
151
                $this->dynamicParameters = $params + $this->dynamicParameters;
1✔
152
                return $this;
1✔
153
        }
154

155

156
        /**
157
         * Add instances of services.
158
         */
159
        public function addServices(array $services): static
1✔
160
        {
161
                $this->services = $services + $this->services;
1✔
162
                return $this;
1✔
163
        }
164

165

166
        protected function getDefaultParameters(): array
167
        {
168
                $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
1✔
169
                $last = end($trace);
1✔
170
                $debugMode = static::detectDebugMode();
1✔
171
                $loaderRc = class_exists(ClassLoader::class)
1✔
172
                        ? new \ReflectionClass(ClassLoader::class)
1✔
173
                        : null;
×
174
                $rootDir = class_exists(InstalledVersions::class) && ($tmp = InstalledVersions::getRootPackage()['install_path'] ?? null)
1✔
175
                        ? rtrim(Nette\Utils\FileSystem::normalizePath($tmp), '\/')
1✔
176
                        : null;
×
177
                $baseUrl = class_exists(Nette\Http\Request::class)
1✔
178
                        ? new Statement(['', 'rtrim'], [new Statement([new Statement('@Nette\Http\IRequest::getUrl'), 'getBaseUrl']), '/'])
1✔
179
                        : null;
×
180
                return [
181
                        'appDir' => isset($trace[1]['file']) ? dirname($trace[1]['file']) : null,
1✔
182
                        'wwwDir' => isset($last['file']) ? dirname($last['file']) : null,
1✔
183
                        'vendorDir' => $loaderRc ? dirname($loaderRc->getFileName(), 2) : null,
1✔
184
                        'rootDir' => $rootDir,
1✔
185
                        'debugMode' => $debugMode,
1✔
186
                        'productionMode' => !$debugMode,
1✔
187
                        'consoleMode' => PHP_SAPI === 'cli',
1✔
188
                        'baseUrl' => $baseUrl,
1✔
189
                ];
190
        }
191

192

193
        public function enableTracy(?string $logDirectory = null, ?string $email = null): void
194
        {
195
                if (!class_exists(Tracy\Debugger::class)) {
×
196
                        throw new Nette\NotSupportedException('Tracy not found, do you have `tracy/tracy` package installed?');
×
197
                }
198

199
                Tracy\Debugger::$strictMode = true;
×
200
                Tracy\Debugger::enable(!$this->staticParameters['debugMode'], $logDirectory, $email);
×
201
                Tracy\Bridges\Nette\Bridge::initialize();
×
202
                if (class_exists(Latte\Bridges\Tracy\BlueScreenPanel::class)) {
×
203
                        Latte\Bridges\Tracy\BlueScreenPanel::initialize();
×
204
                }
205
        }
206

207

208
        /** @deprecated use enableTracy() */
209
        public function enableDebugger(?string $logDirectory = null, ?string $email = null): void
210
        {
211
                $this->enableTracy($logDirectory, $email);
×
212
        }
213

214

215
        /**
216
         * @throws Nette\NotSupportedException if RobotLoader is not available
217
         */
218
        public function createRobotLoader(): Nette\Loaders\RobotLoader
219
        {
220
                if (!class_exists(Nette\Loaders\RobotLoader::class)) {
1✔
221
                        throw new Nette\NotSupportedException('RobotLoader not found, do you have `nette/robot-loader` package installed?');
×
222
                }
223

224
                $loader = new Nette\Loaders\RobotLoader;
1✔
225
                $loader->setTempDirectory($this->getCacheDirectory() . '/nette.robotLoader');
1✔
226
                $loader->setAutoRefresh($this->staticParameters['debugMode']);
1✔
227

228
                if (isset($this->defaultExtensions['application'])) {
1✔
229
                        $this->defaultExtensions['application'][1][1] = null;
1✔
230
                        $this->defaultExtensions['application'][1][3] = $loader;
1✔
231
                }
232

233
                return $loader;
1✔
234
        }
235

236

237
        /**
238
         * Adds configuration file.
239
         */
240
        public function addConfig(string|array $config): static
1✔
241
        {
242
                $this->configs[] = $config;
1✔
243
                return $this;
1✔
244
        }
245

246

247
        /**
248
         * Returns system DI container.
249
         */
250
        public function createContainer(bool $initialize = true): DI\Container
1✔
251
        {
252
                $class = $this->loadContainer();
1✔
253
                $container = new $class($this->dynamicParameters);
1✔
254
                foreach ($this->services as $name => $service) {
1✔
255
                        $container->addService($name, $service);
1✔
256
                }
257

258
                if ($initialize) {
1✔
259
                        $container->initialize();
1✔
260
                }
261

262
                return $container;
1✔
263
        }
264

265

266
        /**
267
         * Loads system DI container class and returns its name.
268
         */
269
        public function loadContainer(): string
270
        {
271
                $loader = new DI\ContainerLoader(
1✔
272
                        $this->getCacheDirectory() . '/nette.configurator',
1✔
273
                        $this->staticParameters['debugMode'],
1✔
274
                );
275
                return $loader->load(
1✔
276
                        [$this, 'generateContainer'],
1✔
277
                        $this->generateContainerKey(),
1✔
278
                );
279
        }
280

281

282
        /**
283
         * @internal
284
         */
285
        public function generateContainer(DI\Compiler $compiler): void
1✔
286
        {
287
                $loader = $this->createLoader();
1✔
288
                $loader->setParameters($this->staticParameters);
1✔
289

290
                foreach ($this->configs as $config) {
1✔
291
                        if (is_string($config)) {
1✔
292
                                $compiler->loadConfig($config, $loader);
1✔
293
                        } else {
294
                                $compiler->addConfig($config);
×
295
                        }
296
                }
297

298
                $compiler->addConfig(['parameters' => DI\Helpers::escape($this->staticParameters)]);
1✔
299
                $compiler->setDynamicParameterNames(array_merge(array_keys($this->dynamicParameters), ['baseUrl']));
1✔
300

301
                $builder = $compiler->getContainerBuilder();
1✔
302
                $builder->addExcludedClasses($this->autowireExcludedClasses);
1✔
303

304
                foreach ($this->defaultExtensions as $name => $extension) {
1✔
305
                        [$class, $args] = is_string($extension)
1✔
306
                                ? [$extension, []]
1✔
307
                                : $extension;
1✔
308
                        if (class_exists($class)) {
1✔
309
                                $args = DI\Helpers::expand($args, $this->staticParameters);
1✔
310
                                $compiler->addExtension($name, (new \ReflectionClass($class))->newInstanceArgs($args));
1✔
311
                        }
312
                }
313

314
                Nette\Utils\Arrays::invoke($this->onCompile, $this, $compiler);
1✔
315
        }
1✔
316

317

318
        protected function createLoader(): DI\Config\Loader
319
        {
320
                return new DI\Config\Loader;
1✔
321
        }
322

323

324
        protected function generateContainerKey(): array
325
        {
326
                return [
327
                        $this->staticParameters,
1✔
328
                        array_keys($this->dynamicParameters),
1✔
329
                        $this->configs,
1✔
330
                        PHP_VERSION_ID - PHP_RELEASE_VERSION, // minor PHP version
1✔
331
                        class_exists(ClassLoader::class) // composer update
1✔
332
                                ? filemtime((new \ReflectionClass(ClassLoader::class))->getFilename())
1✔
333
                                : null,
334
                ];
335
        }
336

337

338
        protected function getCacheDirectory(): string
339
        {
340
                if (empty($this->staticParameters['tempDir'])) {
1✔
341
                        throw new Nette\InvalidStateException('Set path to temporary directory using setTempDirectory().');
1✔
342
                }
343

344
                $dir = $this->staticParameters['tempDir'] . '/cache';
1✔
345
                Nette\Utils\FileSystem::createDir($dir);
1✔
346
                return $dir;
1✔
347
        }
348

349

350
        /**
351
         * Detects debug mode by IP addresses or computer names whitelist detection.
352
         */
353
        public static function detectDebugMode(string|array|null $list = null): bool
1✔
354
        {
355
                $addr = $_SERVER['REMOTE_ADDR'] ?? php_uname('n');
1✔
356
                $secret = is_string($_COOKIE[self::CookieSecret] ?? null)
1✔
357
                        ? $_COOKIE[self::CookieSecret]
1✔
358
                        : null;
1✔
359
                $list = is_string($list)
1✔
360
                        ? preg_split('#[,\s]+#', $list)
1✔
361
                        : (array) $list;
1✔
362
                if (!isset($_SERVER['HTTP_X_FORWARDED_FOR']) && !isset($_SERVER['HTTP_FORWARDED'])) {
1✔
363
                        $list[] = '127.0.0.1';
1✔
364
                        $list[] = '::1';
1✔
365
                }
366

367
                return in_array($addr, $list, strict: true) || in_array("$secret@$addr", $list, strict: true);
1✔
368
        }
369
}
370

371

372
class_exists(Nette\Configurator::class);
1✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc