Assets improved

ActiveTheme.php

@@ -12,6 +12,7 @@
 namespace Liip\ThemeBundle;
 
 use Liip\ThemeBundle\Helper\DeviceDetectionInterface;
+use Liip\ThemeBundle\Locator\ThemeLocator;
 
 /**
  * Contains the currently active theme and allows to change it.
@@ -42,8 +43,12 @@ class ActiveTheme
      * @param array                           $themes
      * @param Helper\DeviceDetectionInterface $deviceDetection
      */
-    public function __construct($name, array $themes = array(), DeviceDetectionInterface $deviceDetection = null)
+    public function __construct($name, array $themes = array(), DeviceDetectionInterface $deviceDetection = null, ThemeLocator $themeLocator = null)
     {
+        if (empty($themes) && !is_null($themeLocator)) {
+            // If no available themes are set in the config and a themeLocator exists
+            $themes = $themeLocator->discoverThemes();
+        }
         $this->setThemes($themes);
 
         if ($name) {
@@ -77,6 +82,11 @@ public function getName()
 
     public function setName($name)
     {
+        if (null === $name) {
+            $this->name = null;
+            return;
+        }
+
         if (!in_array($name, $this->themes)) {
             throw new \InvalidArgumentException(sprintf(
                 'The active theme "%s" must be in the themes list (%s)',

Command/ThemesInstallCommand.php

@@ -0,0 +1,108 @@
+<?php
+
+/*
+ * This file is part of the Liip/ThemeBundle
+ *
+ * (c) Liip AG
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Liip\ThemeBundle\Command;
+
+use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Command that installs themes assets into the web/ folder.
+ *
+ * @author adrienrn
+ */
+class ThemesInstallCommand extends ContainerAwareCommand
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('assets:themes-install')
+            ->setDefinition(array(
+                new InputArgument('target', InputArgument::OPTIONAL, 'The target directory', 'web'),
+            ))
+            ->addOption('symlink', null, InputOption::VALUE_NONE, 'Symlinks the assets instead of copying it')
+            ->setDescription('Installs themes assets into the web directory')
+            ->setHelp(<<<EOT
+The <info>%command.name%</info> command installs themes assets into a given
+directory (e.g. the <comment>web</comment> directory).
+
+  <info>php %command.full_name% web</info>
+
+A "themes" directory will be created inside the target directory and the
+"themes/<options=bold>%theme_name%</>/public" directory of each theme will be copied into it.
+
+To create a symlink to each bundle instead of copying its assets, use the
+<info>--symlink</info> option (will fall back to hard copies when symbolic links aren't possible:
+
+  <info>php %command.full_name% web --symlink</info>
+
+EOT
+            )
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @throws \InvalidArgumentException When the target directory does not exist or symlink cannot be used
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        // Target directory.
+        $targetArg = rtrim($input->getArgument('target'), DIRECTORY_SEPARATOR);
+        if (!is_dir($targetArg)) {
+            throw new \InvalidArgumentException(sprintf('The target directory "%s" does not exist.', $input->getArgument('target')));
+        }
+
+        // Target themes assets directory.
+        $themesAssetsDir = $targetArg.DIRECTORY_SEPARATOR.'themes';
+        if (file_exists($themesAssetsDir)) {
+            $this->getContainer()->get('filesystem')->remove($themesAssetsDir);
+        }
+
+        // Retrieve the active theme.
+        $activeTheme = $this->getContainer()->get('liip_theme.active_theme');
+        $availableThemes = $activeTheme->getThemes();
+
+
+        if (!empty($availableThemes)) {
+            $installedThemes = array();
+
+            // Logging install mode.
+            if ($input->getOption('symlink')) {
+                $output->writeLn(sprintf('Trying to install theme assets as <comment>symbolic links</comment> in <info>%s</info>.', $themesAssetsDir));
+            } else {
+                $output->writeLn(sprintf('Installing theme assets as <comment>hard copies</comment> in <info>%s</info>.', $themesAssetsDir));
+            }
+
+            // Logging list of discovered themes.
+            $output->writeLn(sprintf('Found following theme(s) to install: <comment>%s</comment>.', implode(', ', $availableThemes)));
+            foreach ($availableThemes as $theme) {
+                // Install assets for this theme.
+                $installed = $this->getContainer()->get('liip_theme.installer')->installAssets($theme, $themesAssetsDir, $input->getOption('symlink'));
+                if ($installed === true) {
+                    array_push($installedThemes, $theme);
+                }
+            }
+
+            $output->writeLn(sprintf('<info>Successfully installed assets for %d theme(s).</info>', count($installedThemes)));
+        } else {
+
+            $output->writeLn('<comment>No themes to install.</comment>');
+        }
+    }
+}

Installer.php

@@ -0,0 +1,159 @@
+<?php
+
+/*
+ * This file is part of the Liip/ThemeBundle
+ *
+ * (c) Liip AG
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Liip\ThemeBundle;
+
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Finder\Finder;
+use Liip\ThemeBundle\Locator\ThemeLocator;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Theme installer service.
+ *
+ * This is a service so we can inject it as reference to different parts of the
+ * application. Can be used from command-line using assets:themes-install or to
+ * install assets after uploading a new theme in the app.
+ *
+ * @author adrienrn
+ */
+class Installer
+{
+    /**
+     * Locator service for themes.
+     *
+     * @var \Liip\ThemeBundle\Locator\ThemeLocator
+     */
+    protected $themeLocator;
+
+    /**
+     * Symfony filesystem service.
+     *
+     * @var \Symfony\Component\Filesystem\Filesystem
+     */
+    protected $filesystem;
+
+    /**
+     * Logger.
+     *  Useful since Symfony 2.4 to show output when launching from console.
+     *
+     * @var \Psr\Log\LoggerInterface
+     */
+    protected $logger;
+
+    public function __construct(ThemeLocator $themeLocator, Filesystem $filesystem, LoggerInterface $logger = null)
+    {
+        $this->themeLocator = $themeLocator;
+        $this->filesystem = $filesystem;
+        $this->logger = $logger;
+    }
+
+    /**
+     * Install assets for given $theme in $basePath.
+     *
+     * @param string $theme    Name of the theme
+     * @param string $basePath Path to the target directory, defaults to 'web/themes'
+     * @param bool   $symlink  Whether make a symlink or hard copy
+     */
+    public function installAssets($theme, $basePath = null, $symlink = true)
+    {
+        if (is_null($basePath)) {
+            $basePath = 'web'.DIRECTORY_SEPARATOR.'themes';
+        }
+
+        if (file_exists($basePath) && !is_writable($basePath)) {
+            throw new \InvalidArgumentException(
+                "'basePath' is not writable"
+            );
+        }
+
+        if (!file_exists($basePath)) {
+            // Create base target directory if needed.
+            $this->filesystem->mkdir($basePath, 0777);
+        }
+
+        // Search in bundles first.
+        $pathInfos = $this->themeLocator->locateThemeInBundles($theme, 'X' /* @TODO */);
+        if (!empty($pathInfos)) {
+            // Found theme in bundle.
+            $originDir = $pathInfos['path'];
+
+            // Prepare the directory for this bundle.
+            $themesAssetsBundleDir = $this->getBundleThemesAssetsPath($basePath, $pathInfos['bundle']->getName());
+            if (!is_dir($themesAssetsBundleDir)) {
+                $this->filesystem->mkdir($themesAssetsBundleDir, 0777);
+            }
+
+            $targetDir = $themesAssetsBundleDir.DIRECTORY_SEPARATOR.$theme;
+
+            $this->logger->notice(sprintf('Found theme <comment>%s</comment> in bundle <comment>%s</comment> installing in <comment>%s</comment>', $theme, $pathInfos['bundle']->getName(), $targetDir));
+        } else {
+            // Search in app/
+            $path = $this->themeLocator->locateThemeInApp($theme);
+            if ($path) {
+                $originDir = $path;
+                $targetDir = $basePath.DIRECTORY_SEPARATOR.$theme;
+
+                $this->logger->notice(sprintf('Found theme <comment>%s</comment> in <comment>%s</comment> installing in <comment>%s</comment>', $theme, $originDir, $targetDir));
+            }
+        }
+
+        if (isset($originDir) && isset($targetDir)) {
+            // Only link / mirror the public folder.
+            $originDir = realpath($originDir).DIRECTORY_SEPARATOR.'public';
+
+            if (!is_dir($originDir)) {
+                $this->logger->warning(sprintf('No assets to install for theme %s. <comment>Skipping.</comment>', $theme));
+
+                return false;
+            }
+
+            if ($symlink) {
+                // Symlink.
+                $this->filesystem->symlink($originDir, $targetDir, true);
+            } else {
+                // Hard copy.
+                $this->hardCopy($originDir, $targetDir);
+            }
+
+            return true;
+        }
+
+        $this->logger->warning(sprintf('Theme <comment>%s</comment> not found. <comment>Skipping.</comment>', $theme));
+    }
+
+    /**
+     * Get the path for assets of themes from bundles.
+     *
+     * @param string $basePath
+     * @param string $bundleName
+     *
+     * @return string
+     */
+    public function getBundleThemesAssetsPath($basePath, $bundleName)
+    {
+        return $basePath.DIRECTORY_SEPARATOR.preg_replace('/bundle$/', '', strtolower($bundleName));
+    }
+
+    /**
+     * Mirrors the content of $originDir in $targetDir
+     *     Inspired by symfony assets:install hardCopy.
+     *
+     * @param string $originDir
+     * @param string $targetDir
+     */
+    private function hardCopy($originDir, $targetDir)
+    {
+        $this->filesystem->mkdir($targetDir, 0777);
+        // We use a custom iterator to ignore VCS files
+        $this->filesystem->mirror($originDir, $targetDir, Finder::create()->ignoreDotFiles(false)->in($originDir));
+    }
+}