Merge pull request #66 from sherlockode/feature/remove_tmp_files_cli

Add a CLI to remove temporary files

Author: Vowow

Command/RemoveTemporaryFileCommand.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Sherlockode\AdvancedFormBundle\Command;
+
+use Sherlockode\AdvancedFormBundle\Storage\FilesystemStorage;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Class RemoveTemporaryFileCommand
+ */
+class RemoveTemporaryFileCommand extends Command
+{
+    /**
+     * RemoveTemporaryFileCommand constructor.
+     *
+     * @param FilesystemStorage $storage
+     */
+    public function __construct(FilesystemStorage $storage)
+    {
+        parent::__construct();
+        $this->storage = $storage;
+    }
+
+    protected function configure()
+    {
+        $this
+            ->setName('sherlockode:afb:cleanup-tmp')
+            ->setDescription('Remove all temporary files.')
+            ->addOption('older-than', null, InputOption::VALUE_REQUIRED)
+        ;
+    }
+
+    /**
+     * @param InputInterface  $input
+     * @param OutputInterface $output
+     *
+     * @return int
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $olderThan = $input->getOption('older-than');
+        $limit = null;
+        if ($olderThan) {
+            $limit = clone new \DateTime();
+            $limit->sub(new \DateInterval(sprintf('P%s', strtoupper($olderThan))));
+        }
+
+        $files = $this->storage->all();
+        $count = 0;
+
+        foreach ($this->storage->all() as $filePath) {
+            if ($limit) {
+                $file = $this->storage->getFileObject($filePath);
+                if ($file->getCTime() < $limit->getTimestamp()) {
+                    $this->storage->remove($filePath);
+                    $count++;
+                }
+            } else {
+                $this->storage->remove($filePath);
+                $count++;
+            }
+        }
+
+        $output->writeln(sprintf('<info>%s files has been removed</info>', $count));
+
+        return 0;
+    }
+}

DependencyInjection/SherlockodeAdvancedFormExtension.php

@@ -74,6 +74,7 @@ private function loadServices(ContainerBuilder $container)
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $toBeLoaded = [
+            'command.yml',
             'controller.yml',
             'form.yml',
             'manager.yml',

Resources/config/command.yml

@@ -0,0 +1,6 @@
+services:
+    sherlockode_afb.command.remove_tmp_files:
+        class: Sherlockode\AdvancedFormBundle\Command\RemoveTemporaryFileCommand
+        arguments:
+            - '@sherlockode_afb.storage.tmp_storage'
+        tags: ['console.command']

Resources/doc/temporary_upload.md

@@ -66,3 +66,19 @@ $builder
     ])
 ;
 ```
+
+Remove files from temporary storage
+-------------
+
+Sometimes user uploads a file and never submit the entity form. To remove all non-used temporary files, you can run
+this command:
+
+```bash
+$ php bin/console afb:cleanup:tmpfiles
+```
+
+Use the `older-than` option to only remove older files:
+
+```bash
+$ php bin/console afb:cleanup:tmpfiles --older-than=3d
+```

Storage/FilesystemStorage.php

@@ -2,6 +2,8 @@
 
 namespace Sherlockode\AdvancedFormBundle\Storage;
 
+use Symfony\Component\HttpFoundation\File\File;
+
 class FilesystemStorage implements StorageInterface
 {
     private $dir;
@@ -11,6 +13,21 @@ public function __construct($dir)
         $this->dir = $dir;
     }
 
+    public function all()
+    {
+        $files = [];
+
+        if ($this->dir) {
+            foreach (new \DirectoryIterator($this->dir) as $fileInfo) {
+                if (!$fileInfo->isDot()) {
+                    $files[] = $fileInfo->getFilename();
+                }
+            }
+        }
+
+        return $files;
+    }
+
     public function write($key, $data)
     {
         return file_put_contents($this->dir . '/' . $key, $data);
@@ -25,4 +42,15 @@ public function remove($key)
     {
         return unlink($this->dir  .'/' . $key);
     }
+
+    public function getFileObject($key)
+    {
+        $path = sprintf('%s/%s', $this->dir, $key);
+
+        if (!file_exists($path)) {
+            return null;
+        }
+
+        return new File($path);
+    }
 }

Storage/StorageInterface.php

@@ -2,8 +2,15 @@
 
 namespace Sherlockode\AdvancedFormBundle\Storage;
 
+use Symfony\Component\HttpFoundation\File\File;
+
 interface StorageInterface
 {
+    /**
+     * @return array
+     */
+    public function all();
+
     /**
      * @param string $key
      *
@@ -25,4 +32,11 @@ public function write($key, $data);
      * @return bool
      */
     public function remove($key);
+
+    /**
+     * @param string $key
+     *
+     * @return File
+     */
+    public function getFileObject($key);
 }