fileName = null;
$this->jsonFile = null;
$this->pluginNewlyCreated = null;
$this->pluginComposerBackup = null;
$this->preferredStability = null;
$this->phpVersion = null;
}
/**
* Validate composer.json file permissions and extract necessary info before new requirements are determined
*
* Copied first half of RequireCommand::execute(), which should run before the plugin's update operation
*
* @see RequireCommand::execute()
*
* @param InputInterface $input
* @return int|array
*/
protected function parseComposerJsonFile(InputInterface $input)
{
$file = Factory::getComposerFile();
$io = $this->getIO();
$newlyCreated = !file_exists($file);
if ($newlyCreated && !file_put_contents($file, "{\n}\n")) {
$io->writeError(''.$file.' could not be created.');
return 1;
}
if (!is_readable($file)) {
$io->writeError(''.$file.' is not readable.');
return 1;
}
if (!is_writable($file)) {
$io->writeError(''.$file.' is not writable.');
return 1;
}
if (filesize($file) === 0) {
file_put_contents($file, "{\n}\n");
}
$json = new JsonFile($file);
$composerBackup = file_get_contents($json->getPath());
$composer = $this->getComposer(true, $input->getOption('no-plugins'));
$repos = $composer->getRepositoryManager()->getRepositories();
$platformOverrides = $composer->getConfig()->get('platform') ?: [];
// initialize $this->repos as it is used by the parent InitCommand
$this->repos = new CompositeRepository(array_merge(
[new PlatformRepository([], $platformOverrides)],
$repos
));
if ($composer->getPackage()->getPreferStable()) {
$preferredStability = 'stable';
} else {
$preferredStability = $composer->getPackage()->getMinimumStability();
}
$phpVersion = $this->repos->findPackage('php', '*')->getPrettyVersion();
$this->fileName = $file;
$this->jsonFile = $json;
$this->pluginNewlyCreated = $newlyCreated;
$this->pluginComposerBackup = $composerBackup;
$this->preferredStability = $preferredStability;
$this->phpVersion = $phpVersion;
return 0;
}
/**
* Interactively ask for the requirement arguments
*
* Copied second half of InitCommand::determineRequirements() without calling findBestVersionAndNameForPackage(),
* which would try to use existing requirements before the plugin can update new project values
*
* @see InitCommand::determineRequirements()
*
* @return array
* @throws Exception
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
protected function getRequirementsInteractive(): array
{
$versionParser = new VersionParser();
$io = $this->getIO();
$requires = [];
while (null !== $package = $io->ask('Search for a package: ')) {
$matches = $this->findPackages($package);
if (count($matches)) {
$exactMatch = null;
$choices = [];
foreach ($matches as $position => $foundPackage) {
$abandoned = '';
if (isset($foundPackage['abandoned'])) {
if (is_string($foundPackage['abandoned'])) {
$replacement = sprintf('Use %s instead', $foundPackage['abandoned']);
} else {
$replacement = 'No replacement was suggested';
}
$abandoned = sprintf('Abandoned. %s.', $replacement);
}
$choices[] = sprintf(' %5s %s %s', "[$position]", $foundPackage['name'], $abandoned);
if ($foundPackage['name'] === $package) {
$exactMatch = true;
break;
}
}
// no match, prompt which to pick
if (!$exactMatch) {
$io->writeError([
'',
sprintf('Found %s packages matching %s', count($matches), $package),
'',
]);
$io->writeError($choices);
$io->writeError('');
$validator = function ($selection) use ($matches, $versionParser) {
if ('' === $selection) {
return false;
}
if (is_numeric($selection) && isset($matches[(int) $selection])) {
$package = $matches[(int) $selection];
return $package['name'];
}
if (preg_match('{^\s*(?P[\S/]+)(?:\s+(?P\S+))?\s*$}', $selection, $pkgMatches)) {
if (isset($pkgMatches['version'])) {
// parsing `acme/example ~2.3`
// validate version constraint
$versionParser->parseConstraints($pkgMatches['version']);
return $pkgMatches['name'].' '.$pkgMatches['version'];
}
// parsing `acme/example`
return $pkgMatches['name'];
}
throw new Exception('Not a valid selection');
};
$package = $io->askAndValidate(
'Enter package # to add, or the complete package name if it is not listed: ',
$validator,
3,
false
);
}
// no constraint yet, determine the best version automatically
if (false !== $package && false === strpos($package, ' ')) {
$validator = function ($input) {
$input = trim($input);
return $input ?: false;
};
$constraint = $io->askAndValidate(
'Enter the version constraint to require (or leave blank to use the latest version): ',
$validator,
3,
false
);
if ($constraint !== false) {
$package .= ' '.$constraint;
}
}
if (false !== $package) {
$requires[] = $package;
}
}
}
return $requires;
}
/**
* Reset the composer.json file after an operation failure
*
* Copied from RequireCommand::revertComposerFile() in Composer 1.8.0, it needs to be separate to use the plugin's
* file backup rather than the one that RequireCommand natively picks up, which will contain the plugin's changes
*
* @see RequireCommand::revertComposerFile()
*
* @param string $message
* @return void
*/
protected function revertRootComposerFile(string $message)
{
$file = $this->fileName;
$io = $this->getIO();
if ($this->pluginNewlyCreated) {
if (file_exists($this->jsonFile->getPath())) {
$io->writeError("\n$message, deleting $file.");
unlink($this->jsonFile->getPath());
}
} else {
$io->writeError("\n$message, " .
"reverting $file to its original content from before the magento/project root update.");
file_put_contents($this->jsonFile->getPath(), $this->pluginComposerBackup);
}
}
}