Your IP : 216.73.216.52
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Module\ModuleList;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Component\ComponentRegistrar;
use Magento\Framework\Component\ComponentRegistrarInterface;
use Magento\Framework\Filesystem\DriverInterface;
use Magento\Framework\Module\Declaration\Converter\Dom;
use Magento\Framework\Xml\Parser;
use Magento\Framework\Xml\ParserFactory;
/**
* 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;
/**
* @var \Magento\Framework\Xml\Parser
* @deprecated
* @see $parserFactory
*/
private $parser;
/**
* @var ComponentRegistrarInterface
*/
private $moduleRegistry;
/**
* Filesystem driver to allow reading of module.xml files which live outside of app/code
*
* @var DriverInterface
*/
private $filesystemDriver;
/**
* @var ParserFactory
*
* phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
*/
private readonly ParserFactory $parserFactory;
/**
* Constructor
*
* @param Dom $converter
* @param Parser $parser @deprecated, @see $parserFactory
* @param ComponentRegistrarInterface $moduleRegistry
* @param DriverInterface $filesystemDriver
* @param ParserFactory|null $parserFactory
*/
public function __construct(
Dom $converter,
Parser $parser,
ComponentRegistrarInterface $moduleRegistry,
DriverInterface $filesystemDriver,
?ParserFactory $parserFactory = null,
) {
$this->converter = $converter;
$this->parser = $parser;
$this->moduleRegistry = $moduleRegistry;
$this->filesystemDriver = $filesystemDriver;
$this->parserFactory = $parserFactory ?? ObjectManager::getInstance()->get(ParserFactory::class);
}
/**
* 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 = [];
$excludeSet = array_flip($exclude);
foreach ($this->getModuleConfigs() as list($file, $contents)) {
try {
$parser = $this->parserFactory->create();
$parser->initErrorHandler();
$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($parser->getDom());
$name = key($data);
if (!isset($excludeSet[$name])) {
$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
* @throws \Magento\Framework\Exception\FileSystemException
*/
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);
$sequenceCache = [];
$expanded = [];
foreach (array_keys($modules) as $moduleName) {
$sequence = $this->expandSequence($origList, $moduleName, $sequenceCache);
asort($sequence);
$expanded[] = [
'name' => $moduleName,
'sequence_set' => array_flip($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 (isset($expanded[$i]['sequence_set'][$expanded[$j]['name']])) {
$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
*
* Added a sequence cache to avoid re-computing the sequences of dependencies over and over again.
*
* @param array $list
* @param string $name
* @param array $sequenceCache
* @param array $accumulated
* @param string $parentName
* @return array
* @throws \Exception
*/
private function expandSequence(
array $list,
string $name,
array &$sequenceCache,
array $accumulated = [],
string $parentName = ''
) {
// Making sure we haven't already called the method for this module higher in the stack
if (isset($accumulated[$name])) {
throw new \LogicException("Circular sequence reference from '{$parentName}' to '{$name}'.");
}
$accumulated[$name] = true;
// Checking if we already computed the full sequence for this module
if (!isset($sequenceCache[$name])) {
$sequence = $list[$name]['sequence'] ?? [];
$allSequences = [];
// Going over all immediate dependencies to gather theirs recursively
foreach ($sequence as $relatedName) {
$relatedSequence = $this->expandSequence($list, $relatedName, $sequenceCache, $accumulated, $name);
$allSequences[] = $relatedSequence;
}
$allSequences[] = $sequence;
$sequenceCache[$name] = array_unique(array_merge(...$allSequences));
}
return $sequenceCache[$name] ?? [];
}
}