-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
Loader.php
213 lines (193 loc) · 6.24 KB
/
Loader.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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Module\ModuleList;
use Magento\Framework\Module\Declaration\Converter\Dom;
use Magento\Framework\Xml\Parser;
use Magento\Framework\Component\ComponentRegistrarInterface;
use Magento\Framework\Component\ComponentRegistrar;
use Magento\Framework\Filesystem\DriverInterface;
/**
* Loader of module list information from the filesystem
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class Loader
{
/**
* Converter of XML-files to associative arrays (specific to module.xml file format)
*
* @var Dom
*/
private $converter;
/**
* Parser
*
* @var \Magento\Framework\Xml\Parser
*/
private $parser;
/**
* Module registry
*
* @var ComponentRegistrarInterface
*/
private $moduleRegistry;
/**
* Filesystem driver to allow reading of module.xml files which live outside of app/code
*
* @var DriverInterface
*/
private $filesystemDriver;
/**
* Constructor
*
* @param Dom $converter
* @param Parser $parser
* @param ComponentRegistrarInterface $moduleRegistry
* @param DriverInterface $filesystemDriver
*/
public function __construct(
Dom $converter,
Parser $parser,
ComponentRegistrarInterface $moduleRegistry,
DriverInterface $filesystemDriver
) {
$this->converter = $converter;
$this->parser = $parser;
$this->parser->initErrorHandler();
$this->moduleRegistry = $moduleRegistry;
$this->filesystemDriver = $filesystemDriver;
}
/**
* Loads the full module list information. Excludes modules specified in $exclude.
*
* @param array $exclude
* @throws \Magento\Framework\Exception\LocalizedException
* @return array
*/
public function load(array $exclude = [])
{
$result = [];
foreach ($this->getModuleConfigs() as list($file, $contents)) {
try {
$this->parser->loadXML($contents);
} catch (\Magento\Framework\Exception\LocalizedException $e) {
throw new \Magento\Framework\Exception\LocalizedException(
new \Magento\Framework\Phrase(
'Invalid Document: %1%2 Error: %3',
[$file, PHP_EOL, $e->getMessage()]
),
$e
);
}
$data = $this->converter->convert($this->parser->getDom());
$name = key($data);
if (!in_array($name, $exclude)) {
$result[$name] = $data[$name];
}
}
return $this->sortBySequence($result);
}
/**
* Returns module config data and a path to the module.xml file.
*
* Example of data returned by generator:
* <code>
* [ 'vendor/module/etc/module.xml', '<xml>contents</xml>' ]
* </code>
*
* @return \Traversable
*
* @author Josh Di Fabio <joshdifabio@gmail.com>
*/
private function getModuleConfigs()
{
$modulePaths = $this->moduleRegistry->getPaths(ComponentRegistrar::MODULE);
foreach ($modulePaths as $modulePath) {
$filePath = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, "$modulePath/etc/module.xml");
yield [$filePath, $this->filesystemDriver->fileGetContents($filePath)];
}
}
/**
* Sort the list of modules using "sequence" key in meta-information
*
* @param array $origList
* @return array
* @throws \Exception
*/
private function sortBySequence(array $origList): array
{
ksort($origList);
$modules = $this->prearrangeModules($origList);
$expanded = [];
foreach (array_keys($modules) as $moduleName) {
$sequence = $this->expandSequence($origList, $moduleName);
asort($sequence);
$expanded[] = [
'name' => $moduleName,
'sequence' => $sequence,
];
}
// Use "bubble sorting" because usort does not check each pair of elements and in this case it is important
$total = count($expanded);
for ($i = 0; $i < $total - 1; $i++) {
for ($j = $i; $j < $total; $j++) {
if (in_array($expanded[$j]['name'], $expanded[$i]['sequence'], true)) {
$temp = $expanded[$i];
$expanded[$i] = $expanded[$j];
$expanded[$j] = $temp;
}
}
}
$result = [];
foreach ($expanded as $pair) {
$result[$pair['name']] = $origList[$pair['name']];
}
return $result;
}
/**
* Prearrange all modules by putting those from Magento before the others
*
* @param array $modules
* @return array
*/
private function prearrangeModules(array $modules): array
{
$breakdown = ['magento' => [], 'others' => []];
foreach ($modules as $moduleName => $moduleDetails) {
if (strpos($moduleName, 'Magento_') !== false) {
$breakdown['magento'][$moduleName] = $moduleDetails;
} else {
$breakdown['others'][$moduleName] = $moduleDetails;
}
}
return array_merge($breakdown['magento'], $breakdown['others']);
}
/**
* Accumulate information about all transitive "sequence" references
*
* @param array $list
* @param string $name
* @param array $accumulated
* @return array
* @throws \Exception
*/
private function expandSequence($list, $name, $accumulated = [])
{
$accumulated[] = $name;
$result = $list[$name]['sequence'];
foreach ($result as $relatedName) {
if (in_array($relatedName, $accumulated)) {
throw new \Exception("Circular sequence reference from '{$name}' to '{$relatedName}'.");
}
if (!isset($list[$relatedName])) {
continue;
}
$relatedResult = $this->expandSequence($list, $relatedName, $accumulated);
$result = array_unique(array_merge($result, $relatedResult));
}
return $result;
}
}