Skip to content

[FrameworkBundle] Refactored assets:install command, tweaked output #13057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

[FrameworkBundle] Refactored assets:install command, tweaked output #13057

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fcbfcd1
[FrameworkBundle] Refactored assets:install command, tweaked output
1ed Dec 21, 2014
f7f8f85
Simplify foreach body
1ed Dec 28, 2014
a4f1a0a
Remove recursion
1ed Dec 28, 2014
e8bd573
Make the code more explicit, simplify foreach body
1ed Dec 28, 2014
90d7f06
Simplify method names displayed on the output
1ed Dec 28, 2014
736ec74
Tweaked error handling
1ed Dec 28, 2014
226e98f
Simplify condition
1ed Dec 28, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 110 additions & 45 deletions src/Symfony/Bundle/FrameworkBundle/Command/AssetsInstallCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

namespace Symfony\Bundle\FrameworkBundle\Command;

use Exception;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
Expand All @@ -22,9 +24,15 @@
* Command that places bundle web assets into a given directory.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Gábor Egyed <gabor.egyed@gmail.com>
*/
class AssetsInstallCommand extends ContainerAwareCommand
{
/**
* @var \Symfony\Component\Filesystem\Filesystem
*/
private $filesystem;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did you move $filesystem in the class? now the method symlink is highly coupled to the method configure. please just use read it from the container in both methods. its annoying if you dont know that the configure method is called.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seemed awkward to me to call $this->getContainer()->get('filesystem') in a recursive function. It is coupled to execute not configure and I think that is fine because it is called when the command runs and everything is private so it can be used only in this command anyway.


/**
* {@inheritdoc}
*/
Expand Down Expand Up @@ -74,11 +82,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
throw new \InvalidArgumentException(sprintf('The target directory "%s" does not exist.', $input->getArgument('target')));
}

$filesystem = $this->getContainer()->get('filesystem');
$this->filesystem = $this->getContainer()->get('filesystem');

// Create the bundles directory otherwise symlink will fail.
$bundlesDir = $targetArg.'/bundles/';
$filesystem->mkdir($bundlesDir, 0777);
$this->filesystem->mkdir($bundlesDir, 0777);

// relative implies symlink
$symlink = $input->getOption('symlink') || $input->getOption('relative');
Expand All @@ -89,62 +97,119 @@ protected function execute(InputInterface $input, OutputInterface $output)
$output->writeln('Installing assets as <comment>hard copies</comment>.');
}

$table = new Table($output);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using a table has a huge drawback compared to the previous output: it is not streaming the output anymore, but waiting for all bundles to be processed before rendering anything. And if any exception happens, there won't be any report about the symlinks which have already been created

$table->setHeaders(array('Source', 'Target', 'Method / Error'));

$failed = 0;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$failed looks like a name for a boolean property, and this is not the case. Naming it $exitCode would be better, or using a real boolean (and then changing the return statement to return an integer depending on this boolean)

foreach ($this->getContainer()->get('kernel')->getBundles() as $bundle) {
if (is_dir($originDir = $bundle->getPath().'/Resources/public')) {
$targetDir = $bundlesDir.preg_replace('/bundle$/', '', strtolower($bundle->getName()));

$output->writeln(sprintf('Installing assets for <comment>%s</comment> into <comment>%s</comment>', $bundle->getNamespace(), $targetDir));

$filesystem->remove($targetDir);

if ($symlink) {
if ($input->getOption('relative')) {
$relativeOriginDir = $filesystem->makePathRelative($originDir, realpath($bundlesDir));
} else {
$relativeOriginDir = $originDir;
}

try {
$filesystem->symlink($relativeOriginDir, $targetDir);
if (!file_exists($targetDir)) {
throw new IOException('Symbolic link is broken');
}
$output->writeln('The assets were installed using symbolic links.');
} catch (IOException $e) {
if (!$input->getOption('relative')) {
$this->hardCopy($originDir, $targetDir);
$output->writeln('It looks like your system doesn\'t support symbolic links, so the assets were installed by copying them.');
}

// try again without the relative option
try {
$filesystem->symlink($originDir, $targetDir);
if (!file_exists($targetDir)) {
throw new IOException('Symbolic link is broken');
}
$output->writeln('It looks like your system doesn\'t support relative symbolic links, so the assets were installed by using absolute symbolic links.');
} catch (IOException $e) {
$this->hardCopy($originDir, $targetDir);
$output->writeln('It looks like your system doesn\'t support symbolic links, so the assets were installed by copying them.');
}
}
if (!is_dir($originDir = $bundle->getPath().'/Resources/public')) {
continue;
}

$targetDir = $bundlesDir.preg_replace('/bundle$/', '', strtolower($bundle->getName()));

try {
$this->filesystem->remove($targetDir);

if ($input->getOption('relative')) {
$methodOrError = $this->relativeSymlinkWithFallback($originDir, $targetDir);
} elseif ($symlink) {
$methodOrError = $this->absoluteSymlinkWithFallback($originDir, $targetDir);
} else {
$this->hardCopy($originDir, $targetDir);
$methodOrError = $this->hardCopy($originDir, $targetDir);
}
} catch (Exception $e) {
$methodOrError = sprintf('<error>%s</error>', $e->getMessage());
$failed = 1;
}

$table->addRow(array($bundle->getNamespace(), $targetDir, $methodOrError));
}

$table->render();

return $failed;
}

/**
* Try to create relative symlink.
*
* Falling back to absolute symlink and finally hard copy.
*
* @param string $originDir
* @param string $targetDir
*
* @return string
*/
private function hardCopy($originDir, $targetDir)
private function relativeSymlinkWithFallback($originDir, $targetDir)
{
try {
$this->symlink($originDir, $targetDir, true);
$method = 'relative symlink';
} catch (IOException $e) {
$method = $this->absoluteSymlinkWithFallback($originDir, $targetDir);
}

return $method;
}

/**
* Try to create absolute symlink.
*
* Falling back to hard copy.
*
* @param string $originDir
* @param string $targetDir
*
* @return string
*/
private function absoluteSymlinkWithFallback($originDir, $targetDir)
{
$filesystem = $this->getContainer()->get('filesystem');
try {
$this->symlink($originDir, $targetDir);
$method = 'absolute symlink';
} catch (IOException $e) {
// fall back to copy
$method = $this->hardCopy($originDir, $targetDir);
}

$filesystem->mkdir($targetDir, 0777);
return $method;
}

/**
* Creates symbolic link.
*
* @param string $originDir
* @param string $targetDir
* @param bool $relative
*
* @throws IOException If link can not be created.
*/
private function symlink($originDir, $targetDir, $relative = false)
{
if ($relative) {
$originDir = $this->filesystem->makePathRelative($originDir, realpath(dirname($targetDir)));
}
$this->filesystem->symlink($originDir, $targetDir);
if (!file_exists($targetDir)) {
throw new IOException(sprintf('Symbolic link "%s" is created but appears to be broken.', $targetDir), 0, null, $targetDir);
}
}

/**
* Copies origin to target.
*
* @param string $originDir
* @param string $targetDir
*
* @return string
*/
private function hardCopy($originDir, $targetDir)
{
$this->filesystem->mkdir($targetDir, 0777);
// We use a custom iterator to ignore VCS files
$filesystem->mirror($originDir, $targetDir, Finder::create()->ignoreDotFiles(false)->in($originDir));
$this->filesystem->mirror($originDir, $targetDir, Finder::create()->ignoreDotFiles(false)->in($originDir));

return 'copy';
}
}