Security update for Core, with self-updated composer
[yaffs-website] / vendor / drupal / console-core / src / Utils / ConfigurationManager.php
1 <?php
2
3 namespace Drupal\Console\Core\Utils;
4
5 use Symfony\Component\Yaml\Yaml;
6 use Symfony\Component\Console\Input\ArgvInput;
7 use Symfony\Component\Finder\Finder;
8 use Dflydev\DotAccessConfiguration\YamlFileConfigurationBuilder;
9 use Dflydev\DotAccessConfiguration\ConfigurationInterface;
10 use Webmozart\PathUtil\Path;
11
12 /**
13  * Class ConfigurationManager.
14  */
15 class ConfigurationManager
16 {
17     /**
18      * @var ConfigurationInterface
19      */
20     private $configuration = null;
21
22     /**
23      * @var string
24      */
25     private $applicationDirectory = null;
26
27     /**
28      * @var array
29      */
30     private $configurationDirectories = [];
31
32     /**
33      * @var array
34      */
35     private $sites = [];
36
37     /**
38      * @var array
39      */
40     private $configurationFiles = [];
41
42     /**
43      * @param $directory
44      * @return $this
45      */
46     public function loadConfiguration($directory)
47     {
48         $this->locateConfigurationFiles();
49
50         $this->applicationDirectory = $directory;
51         if ($directory && is_dir($directory) && strpos($directory, 'phar:')!==0) {
52             $this->addConfigurationFilesByDirectory(
53                 $directory . '/console/',
54                 true
55             );
56         }
57         $input = new ArgvInput();
58         $root = $input->getParameterOption(['--root']);
59         if ($root && is_dir($root)) {
60             $this->addConfigurationFilesByDirectory(
61                 $root. '/console/',
62                 true
63             );
64         }
65
66         $builder = new YamlFileConfigurationBuilder(
67             $this->configurationFiles['config']
68         );
69
70         $this->configuration = $builder->build();
71
72         $extras = [
73             'aliases',
74             'mappings',
75             'defaults'
76         ];
77
78         foreach ($extras as $extra) {
79             $extraKey = 'application.extras.'.$extra;
80             $extraFlag = $this->configuration->get($extraKey)?:'true';
81             if ($extraFlag === 'true') {
82                 $this->appendExtraConfiguration($extra);
83             }
84         }
85
86         return $this;
87     }
88
89     /**
90      * @return ConfigurationInterface
91      */
92     public function getConfiguration()
93     {
94         return $this->configuration;
95     }
96
97     private function readSite($siteFile)
98     {
99         if (!file_exists($siteFile)) {
100             return [];
101         }
102
103         return Yaml::parse(file_get_contents($siteFile));
104     }
105
106     /**
107      * @param $target
108      *
109      * @return array
110      */
111     public function readTarget($target)
112     {
113         $site = $target;
114         $environment = null;
115         $exploded = explode('.', $target, 2);
116
117         if (count($exploded)>1) {
118             $site = $exploded[0];
119             $environment = $exploded[1];
120         }
121
122         $sites = $this->getSites();
123         if (!array_key_exists($site, $sites)) {
124             return [];
125         }
126
127         $targetInformation = $sites[$site];
128
129         if ($environment) {
130             if (!array_key_exists($environment, $sites[$site])) {
131                 return [];
132             }
133
134             $targetInformation = $sites[$site][$environment];
135         }
136
137         return $targetInformation;
138     }
139
140     /**
141      * @return string
142      */
143     public function getApplicationDirectory()
144     {
145         return $this->applicationDirectory;
146     }
147
148     /**
149      * Return the sites config directory.
150      *
151      * @return array
152      */
153     private function getSitesDirectories()
154     {
155         $sitesDirectories = array_map(
156             function ($directory) {
157                 return $directory . 'sites';
158             },
159             $this->getConfigurationDirectories()
160         );
161
162         $sitesDirectories = array_filter(
163             $sitesDirectories,
164             function ($directory) {
165                 return is_dir($directory);
166             }
167         );
168
169         $sitesDirectories = array_unique($sitesDirectories);
170
171         return $sitesDirectories;
172     }
173
174     /**
175      * @param string $commandName
176      * @return mixed
177      */
178     public function readDrushEquivalents($commandName)
179     {
180         $equivalents = [];
181         $drushMappings = Yaml::parse(
182             file_get_contents(
183                 $this->applicationDirectory . DRUPAL_CONSOLE_CORE . 'config/drush.yml'
184             )
185         );
186
187         foreach ($drushMappings['commands'] as $key => $commands) {
188             foreach ($commands as $namespace => $command) {
189                 if ($command) {
190                     $equivalents[$namespace] = $command;
191                 }
192             }
193         }
194
195         if (!$commandName) {
196             $drushMappings = [];
197             foreach ($equivalents as $key => $alternative) {
198                 $drushMappings[] = [$key, $alternative];
199             }
200
201             return $drushMappings;
202         }
203
204         if (array_key_exists($commandName, $equivalents)) {
205             return $equivalents[$commandName] ?: ' ';
206         }
207
208         return [];
209     }
210
211     public function getVendorCoreRoot()
212     {
213         $consoleCoreDirectory = dirname(dirname(dirname(__FILE__))) . '/';
214
215         if (is_dir($consoleCoreDirectory)) {
216             return $consoleCoreDirectory;
217         }
218
219         return null;
220     }
221
222     public function getVendorCoreDirectory()
223     {
224         $consoleCoreDirectory = dirname(dirname(dirname(__FILE__))) . '/config/';
225
226         if (is_dir($consoleCoreDirectory)) {
227             return $consoleCoreDirectory;
228         }
229
230         return null;
231     }
232
233     public function getSystemDirectory()
234     {
235         $systemDirectory = '/etc/console/';
236
237         if (is_dir($systemDirectory)) {
238             return $systemDirectory;
239         }
240
241         return null;
242     }
243
244     /**
245      * @return string
246      */
247     public function getConsoleDirectory()
248     {
249         $consoleDirectory = sprintf(
250             '%s/.console/',
251             $this->getHomeDirectory()
252         );
253
254         if (is_dir($consoleDirectory)) {
255             return $consoleDirectory;
256         }
257
258         try {
259             mkdir($consoleDirectory, 0777, true);
260         } catch (\Exception $exception) {
261             return null;
262         }
263
264         return $consoleDirectory;
265     }
266
267     /**
268      * @param $includeVendorCore
269      *
270      * @return array
271      */
272     public function getConfigurationDirectories($includeVendorCore = false)
273     {
274         if ($this->configurationDirectories) {
275             if ($includeVendorCore) {
276                 return array_merge(
277                     [$this->getVendorCoreDirectory()],
278                     $this->configurationDirectories
279                 );
280             }
281
282             return $this->configurationDirectories;
283         }
284
285         return [];
286     }
287
288     private function addConfigurationFilesByDirectory(
289         $directory,
290         $addDirectory = false
291     ) {
292         if ($addDirectory) {
293             $this->configurationDirectories[] = $directory;
294         }
295         $configurationFiles = [
296             'config' => 'config.yml',
297             'drush' => 'drush.yml',
298             'aliases' => 'aliases.yml',
299             'mappings' => 'mappings.yml',
300             'defaults' => 'defaults.yml',
301         ];
302         foreach ($configurationFiles as $key => $file) {
303             $configFile = $directory.$file;
304             if (is_file($configFile)) {
305                 $this->configurationFiles[$key][] = $configFile;
306             }
307         }
308     }
309
310     private function locateConfigurationFiles()
311     {
312         if ($this->getVendorCoreDirectory()) {
313             $this->addConfigurationFilesByDirectory(
314                 $this->getVendorCoreDirectory()
315             );
316         }
317         if ($this->getSystemDirectory()) {
318             $this->addConfigurationFilesByDirectory(
319                 $this->getSystemDirectory(),
320                 true
321             );
322         }
323         if ($this->getConsoleDirectory()) {
324             $this->addConfigurationFilesByDirectory(
325                 $this->getConsoleDirectory(),
326                 true
327             );
328         }
329     }
330
331     /**
332      * @return void
333      */
334     private function appendExtraConfiguration($type)
335     {
336         if (!array_key_exists($type, $this->configurationFiles)) {
337             return;
338         }
339
340         $configData = [];
341         foreach ($this->configurationFiles[$type] as $configFile) {
342             if (file_get_contents($configFile)==='') {
343                 continue;
344             }
345             $parsed = Yaml::parse(file_get_contents($configFile));
346             $configData = array_merge(
347                 $configData,
348                 is_array($parsed)?$parsed:[]
349             );
350         }
351
352         if ($configData && array_key_exists($type, $configData)) {
353             $this->configuration->set(
354                 'application.commands.'.$type,
355                 $configData[$type]
356             );
357         }
358     }
359
360     public function loadExtendConfiguration()
361     {
362         $directory = $this->getConsoleDirectory() . '/extend/';
363         if (!is_dir($directory)) {
364             return null;
365         }
366
367         $autoloadFile = $directory . 'vendor/autoload.php';
368         if (!is_file($autoloadFile)) {
369             return null;
370         }
371         include_once $autoloadFile;
372         $extendFile = $directory . 'extend.console.config.yml';
373
374         $this->importConfigurationFromFile($extendFile);
375     }
376
377     private function importConfigurationFromFile($configFile)
378     {
379         if (is_file($configFile) && file_get_contents($configFile)!='') {
380             $builder = new YamlFileConfigurationBuilder([$configFile]);
381             if ($this->configuration) {
382                 $this->configuration->import($builder->build());
383             } else {
384                 $this->configuration = $builder->build();
385             }
386         }
387     }
388
389     /**
390      * @return array
391      */
392     public function getSites()
393     {
394         if ($this->sites) {
395             return $this->sites;
396         }
397
398         $sitesDirectories = $this->getSitesDirectories();
399
400         if (!$sitesDirectories) {
401             return [];
402         }
403
404         $finder = new Finder();
405         $finder->in($sitesDirectories);
406         $finder->name("*.yml");
407
408         foreach ($finder as $site) {
409             $siteName = $site->getBasename('.yml');
410             $environments = $this->readSite($site->getRealPath());
411
412             if (!$environments || !is_array($environments)) {
413                 continue;
414             }
415
416             $this->sites[$siteName] = [
417                 'file' => $site->getRealPath()
418             ];
419
420             foreach ($environments as $environment => $config) {
421                 if (!array_key_exists('type', $config)) {
422                     throw new \UnexpectedValueException("The 'type' parameter is required in sites configuration.");
423                 }
424                 if ($config['type'] !== 'local') {
425                     if (array_key_exists('host', $config)) {
426                         $targetInformation['remote'] = true;
427                     }
428
429                     $config = array_merge(
430                         $this->configuration->get('application.remote')?:[],
431                         $config
432                     );
433                 }
434
435                 $this->sites[$siteName][$environment] = $config;
436             }
437         }
438
439         return $this->sites;
440     }
441
442     /**
443      * @return array
444      */
445     public function getConfigurationFiles()
446     {
447         return $this->configurationFiles;
448     }
449
450     public function getHomeDirectory()
451     {
452         return Path::getHomeDirectory();
453     }
454 }