Add a --cache option on translation:download to clear the cache (#139)

* Add a --cache option on translation:download to clear the cache

* Refactor the cache clearer as a service and better hash generation

* Fix CS and missing stuff

* Order files and avoid ~ suffix

Author: damienalexandre

Changelog.md

@@ -2,27 +2,33 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## Unreleased
+
+## Added
+
+- New `--cache` option on the `translation:download` allowing to clear the cache automatically if the downloaded translations have changed.
+
 ## 0.4.0
 
 Major improvements on this version. Be aware that the default format to store translation has changed to XLIFF 2.0. If you
-run the extract command you will automatically get updated files. 
+run the extract command you will automatically get updated files.
 
 ### Added
 
 - More extractors from `php-translation/extractor`
-- Show status after extract command 
+- Show status after extract command
 - Added status command
 - Support for PHPUnit6
 - Support for `php-translation/symfony-storage` 0.3.0
 - Using dumper and loader from `php-translation/extractor`
-- `CatalogeCounter` to show statistics about a catalogue. 
-- Lots of more tests. Test coverage increased from 27% to 69%.
+- `CatalogueCounter` to show statistics about a catalogue
+- Lots of more tests. Test coverage increased from 27% to 69%
 
 ### Changed
 
 - `Importer` returns an `ImportResult` value object
 - Improved internal management of metadata. Introduced a new `Metadata` model
-- Renamed `MetadataAwareMerged` to `ReplaceOperation`, read the class doc for the updated syntax. 
+- Renamed `MetadataAwareMerged` to `ReplaceOperation`, read the class doc for the updated syntax
 
 ### Fixed
 
@@ -31,7 +37,7 @@ run the extract command you will automatically get updated files.
 ### Removed
 
 - Removed `WebUIMessage` and `EditInPlaceMessage`. Use `Message` from `php-translation/common` instead
-- Removed metadata related functions from `CatalogueManager` 
+- Removed metadata related functions from `CatalogueManager`
 
 ### Changed
 
@@ -55,7 +61,7 @@ run the extract command you will automatically get updated files.
 
 ### Fixed
 
-- When using EditInPlace, we only mark twig filters (`trans` & `transchoice`) as "safe" when EditInPlace in active. 
+- When using EditInPlace, we only mark twig filters (`trans` & `transchoice`) as "safe" when EditInPlace in active.
 
 ## 0.3.3
 

Command/DownloadCommand.php

@@ -13,9 +13,12 @@
 
 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;
+use Symfony\Component\Finder\Finder;
 use Translation\Bundle\Service\StorageService;
+use Translation\Bundle\Model\Configuration;
 
 /**
  * @author Tobias Nyholm <[email protected]>
@@ -27,15 +30,50 @@ protected function configure()
         $this
             ->setName('translation:download')
             ->setDescription('Replace local messages with messages from remote')
-            ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default');
+            ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
+            ->addOption('cache', null, InputOption::VALUE_NONE, 'Clear the cache if the translations have changed')
+        ;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $container = $this->getContainer();
         $configName = $input->getArgument('configuration');
+
         /** @var StorageService $storage */
         $storage = $container->get('php_translation.storage.'.$configName);
-        $storage->download();
+        /** @var Configuration $configuration */
+        $configuration = $this->getContainer()->get('php_translation.configuration.'.$configName);
+
+        if ($input->getOption('cache')) {
+            $translationsDirectory = $configuration->getOutputDir();
+            $md5BeforeDownload = $this->hashDirectory($translationsDirectory);
+            $storage->download();
+            $md5AfterDownload = $this->hashDirectory($translationsDirectory);
+
+            if ($md5BeforeDownload !== $md5AfterDownload) {
+                $cacheClearer = $this->getContainer()->get('php_translation.cache_clearer');
+                $cacheClearer->clearAndWarmUp();
+            }
+        } else {
+            $storage->download();
+        }
+    }
+
+    private function hashDirectory($directory)
+    {
+        if (!is_dir($directory)) {
+            return false;
+        }
+
+        $finder = new Finder();
+        $finder->files()->in($directory)->notName('/~$/')->sortByName();
+
+        $hash = hash_init('md5');
+        foreach ($finder as $file) {
+            hash_update_file($hash, $file->getRealPath());
+        }
+
+        return hash_final($hash);
     }
 }

Controller/EditInPlaceController.php

@@ -12,7 +12,6 @@
 namespace Translation\Bundle\Controller;
 
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-use Symfony\Component\Finder\Finder;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Translation\Bundle\Exception\MessageValidationException;
@@ -45,45 +44,12 @@ public function editAction(Request $request, $configName, $locale)
             $storage->update($message);
         }
 
-        $this->rebuildTranslations($locale);
+        $cacheClearer = $this->get('php_translation.cache_clearer');
+        $cacheClearer->clearAndWarmUp($locale);
 
         return new Response();
     }
 
-    /**
-     * Remove the Symfony translation cache and warm it up again.
-     *
-     * @param $locale
-     */
-    private function rebuildTranslations($locale)
-    {
-        $cacheDir = $this->getParameter('kernel.cache_dir');
-        $translationDir = sprintf('%s/translations', $cacheDir);
-
-        $filesystem = $this->get('filesystem');
-        $finder = new Finder();
-
-        if (!is_dir($translationDir)) {
-            mkdir($translationDir);
-        }
-
-        if (!is_writable($translationDir)) {
-            throw new \RuntimeException(sprintf('Unable to write in the "%s" directory', $translationDir));
-        }
-
-        // Remove the translations for this locale
-        $files = $finder->files()->name('*.'.$locale.'.*')->in($translationDir);
-        foreach ($files as $file) {
-            $filesystem->remove($file);
-        }
-
-        // Build them again
-        $translator = $this->get('translator');
-        if (method_exists($translator, 'warmUp')) {
-            $translator->warmUp($translationDir);
-        }
-    }
-
     /**
      * Get and validate messages from the request.
      *

Resources/config/services.yml

@@ -25,6 +25,10 @@ services:
     class: Translation\Bundle\Service\Importer
     arguments: ["@php_translation.extractor"]
 
+  php_translation.cache_clearer:
+    class: Translation\Bundle\Service\CacheClearer
+    arguments: ["%kernel.cache_dir%", "@translator", "@filesystem"]
+
   php_translation.local_file_storage.abstract:
     class: Translation\SymfonyStorage\FileStorage
     abstract: true

Service/CacheClearer.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the PHP Translation package.
+ *
+ * (c) PHP Translation team <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Translation\Bundle\Service;
+
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
+use Symfony\Component\Translation\TranslatorInterface;
+
+/**
+ * A service able to read and clear the Symfony Translation cache.
+ *
+ * @author Damien A. <[email protected]>
+ */
+final class CacheClearer
+{
+    /**
+     * @var string
+     */
+    private $kernelCacheDir;
+
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    /**
+     * @var Filesystem
+     */
+    private $filesystem;
+
+    public function __construct($kernelCacheDir, TranslatorInterface $translator, Filesystem $filesystem)
+    {
+        $this->kernelCacheDir = $kernelCacheDir;
+        $this->translator = $translator;
+        $this->filesystem = $filesystem;
+    }
+
+    /**
+     * Remove the Symfony translation cache and warm it up again.
+     *
+     * @param string|null $locale Optional filter to clear only one locale.
+     */
+    public function clearAndWarmUp($locale = null)
+    {
+        $translationDir = sprintf('%s/translations', $this->kernelCacheDir);
+
+        $finder = new Finder();
+
+        // Make sure the directory exists
+        $this->filesystem->mkdir($translationDir);
+
+        // Remove the translations for this locale
+        $files = $finder->files()->name($locale ? '*.'.$locale.'.*' : '*')->in($translationDir);
+        foreach ($files as $file) {
+            $this->filesystem->remove($file);
+        }
+
+        // Build them again
+        if ($this->translator instanceof WarmableInterface) {
+            $this->translator->warmUp($translationDir);
+        }
+    }
+}