Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/framework/Module/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Module;
use Magento\Framework\Component\ComponentRegistrar;
/**
* Provide information of dependencies and conflicts in composer.json files.
*
* Mapping of package name to module name, and mapping of module name to package version.
*/
class PackageInfo
{
/**
* Package name to module name map
*
* @var string[]
*/
private $packageModuleMap;
/**
* Map of module name to package version
*
* @var string[]
*/
private $modulePackageVersionMap;
/**
* "require" field of each module, contains depending modules' name
*
* @var array[]
*/
private $requireMap;
/**
* "conflict" field of each module, contains conflicting modules' name and version constraint
*
* @var array[]
*/
private $conflictMap;
/**
* Reader of composer.json files
*
* @var Dir\Reader
*/
private $reader;
/**
* @var ComponentRegistrar
*/
private $componentRegistrar;
/**
* @var array
*/
protected $nonExistingDependencies = [];
/**
* @var \Magento\Framework\Serialize\Serializer\Json
*/
private $serializer;
/**
* @param Dir\Reader $reader
* @param ComponentRegistrar $componentRegistrar
* @param \Magento\Framework\Serialize\Serializer\Json|null $serializer
* @throws \RuntimeException
*/
public function __construct(
Dir\Reader $reader,
ComponentRegistrar $componentRegistrar,
\Magento\Framework\Serialize\Serializer\Json $serializer = null
) {
$this->reader = $reader;
$this->componentRegistrar = $componentRegistrar;
$this->serializer = $serializer?: \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Framework\Serialize\Serializer\Json::class);
}
/**
* Load the packages information
*
* @return void
* @throws \InvalidArgumentException
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
private function load()
{
if ($this->packageModuleMap === null) {
$jsonData = $this->reader->getComposerJsonFiles()->toArray();
foreach ($this->componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $moduleName => $moduleDir) {
$key = $moduleDir . '/composer.json';
if (isset($jsonData[$key]) && $jsonData[$key]) {
try {
$packageData = $this->serializer->unserialize($jsonData[$key]);
} catch (\InvalidArgumentException $e) {
throw new \InvalidArgumentException(
sprintf(
"%s composer.json error: %s",
$moduleName,
$e->getMessage()
)
);
}
if (isset($packageData['name'])) {
$this->packageModuleMap[$packageData['name']] = $moduleName;
}
if (isset($packageData['version'])) {
$this->modulePackageVersionMap[$moduleName] = $packageData['version'];
}
if (!empty($packageData['require'])) {
$this->requireMap[$moduleName] = array_keys($packageData['require']);
}
if (!empty($packageData['conflict'])) {
$this->conflictMap[$moduleName] = $packageData['conflict'];
}
}
}
}
}
/**
* Get module name of a package
*
* @param string $packageName
* @return string
*/
public function getModuleName($packageName)
{
$this->load();
$moduleName = null;
if (isset($this->packageModuleMap[$packageName])) {
$moduleName = $this->packageModuleMap[$packageName];
} elseif ($this->isMagentoPackage($packageName)) {
$moduleName = $this->convertPackageNameToModuleName($packageName);
$this->addNonExistingDependency($moduleName);
}
return $moduleName;
}
/**
* Add non existing dependency
*
* @param string $dependency
* @return void
*/
protected function addNonExistingDependency($dependency)
{
if (!isset($this->nonExistingDependencies[$dependency])) {
$this->nonExistingDependencies[$dependency] = $dependency;
}
}
/**
* Return list of non existing dependencies
*
* @return array
*/
public function getNonExistingDependencies()
{
return $this->nonExistingDependencies;
}
/**
* Build module name based on internal package name
*
* @param string $packageName
* @return string|null
*/
protected function convertPackageNameToModuleName($packageName)
{
$moduleName = str_replace('magento/module-', '', $packageName);
$moduleName = str_replace('-', '', ucwords($moduleName, '-'));
return 'Magento_' . $moduleName;
}
/**
* Check if package is internal magento module
*
* @param string $packageName
* @return bool
*/
protected function isMagentoPackage($packageName)
{
return $packageName !== null && strpos($packageName, 'magento/module-') === 0;
}
/**
* Get package name of a module
*
* @param string $moduleName
* @return string
*/
public function getPackageName($moduleName)
{
$this->load();
return array_search($moduleName, $this->packageModuleMap) ?: '';
}
/**
* Convert an array of package names to module names
*
* @param string[] $packageNames
* @return string[]
*/
private function convertToModuleNames($packageNames)
{
$moduleNames = [];
foreach ($packageNames as $package) {
$moduleNames[] = $this->getModuleName($package);
}
return $moduleNames;
}
/**
* Get all module names a module requires
*
* @param string $moduleName
* @return array
*/
public function getRequire($moduleName)
{
$this->load();
$require = [];
if (isset($this->requireMap[$moduleName])) {
$require = $this->convertToModuleNames($this->requireMap[$moduleName]);
}
return $require;
}
/**
* Get all module names a module required by
*
* @param string $requiredModuleName
* @return array
*/
public function getRequiredBy($requiredModuleName)
{
$this->load();
$requiredBy = [];
foreach ($this->requireMap as $moduleName => $moduleRequireList) {
if (in_array($requiredModuleName, $moduleRequireList)) {
$requiredBy[] = $moduleName;
}
}
return $requiredBy;
}
/**
* Get all module names a module conflicts
*
* @param string $moduleName
* @return array
*/
public function getConflict($moduleName)
{
$this->load();
$conflict = [];
if (isset($this->conflictMap[$moduleName])) {
$conflict = array_combine(
$this->convertToModuleNames(array_keys($this->conflictMap[$moduleName])),
$this->conflictMap[$moduleName]
);
}
return $conflict;
}
/**
* Get package version of a module
*
* @param string $moduleName
* @return string
*/
public function getVersion($moduleName)
{
$this->load();
return $this->modulePackageVersionMap[$moduleName] ?? '';
}
}