Added a few utils task to list and remove files from a filesystem

Author: Valentin Clavreul

Task/FilesystemOptionTrait.php

@@ -0,0 +1,49 @@
+<?php declare(strict_types=1);
+/**
+ * This file is part of the CleverAge/FlysystemProcessBundle package.
+ *
+ * Copyright (C) 2017-2019 Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\FlysystemProcessBundle\Task;
+
+use CleverAge\ProcessBundle\Model\ProcessState;
+use League\Flysystem\FilesystemInterface;
+use League\Flysystem\MountManager;
+use Symfony\Component\OptionsResolver\Options;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Tools to use filesystem inside task configurations
+ */
+trait FilesystemOptionTrait
+{
+    protected function configureFilesystemOption(OptionsResolver $resolver, $optionName)
+    {
+        $resolver->setRequired($optionName);
+        $resolver->setAllowedTypes($optionName, 'string');
+        $resolver->setNormalizer($optionName, function (Options $options, $value) {
+            return $this->getMountManager()->getFilesystem($value);
+        });
+    }
+
+    protected function getFilesystem(ProcessState $state, $optionName): FilesystemInterface
+    {
+        return $this->getOption($state, $optionName);
+    }
+
+    abstract protected function getMountManager(): MountManager;
+
+    /**
+     * @see \CleverAge\ProcessBundle\Model\AbstractConfigurableTask::getOption
+     *
+     * @param ProcessState $state
+     * @param string             $code
+     *
+     * @return mixed
+     */
+    abstract protected function getOption(ProcessState $state, $code);
+}

Task/ListContentTask.php

@@ -0,0 +1,111 @@
+<?php declare(strict_types=1);
+/**
+ * This file is part of the CleverAge/FlysystemProcessBundle package.
+ *
+ * Copyright (C) 2017-2019 Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\FlysystemProcessBundle\Task;
+
+use CleverAge\ProcessBundle\Model\AbstractConfigurableTask;
+use CleverAge\ProcessBundle\Model\IterableTaskInterface;
+use CleverAge\ProcessBundle\Model\ProcessState;
+use League\Flysystem\FilesystemInterface;
+use League\Flysystem\MountManager;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Iterate over the content of a filesystem
+ */
+class ListContentTask extends AbstractConfigurableTask implements IterableTaskInterface
+{
+    use FilesystemOptionTrait;
+
+    /** @var  MountManager */
+    protected $mountManager;
+
+    /** @var array|null */
+    protected $fsContent = null;
+
+    /**
+     * ListContentTask constructor.
+     *
+     * @param MountManager $mountManager
+     */
+    public function __construct(MountManager $mountManager)
+    {
+        $this->mountManager = $mountManager;
+    }
+
+    protected function configureOptions(OptionsResolver $resolver)
+    {
+        $this->configureFilesystemOption($resolver, 'filesystem');
+
+        $resolver->setDefault('file_pattern', null);
+        $resolver->setAllowedTypes('file_pattern', ['null', 'string']);
+    }
+
+    /**
+     * @param ProcessState $state
+     *
+     * @throws \Symfony\Component\OptionsResolver\Exception\ExceptionInterface
+     */
+    public function execute(ProcessState $state)
+    {
+        if ($this->fsContent === null || key($this->fsContent) === null) {
+            $filesystem = $this->getFilesystem($state, 'filesystem');
+            $pattern = $this->getOption($state, 'file_pattern');
+
+            $this->fsContent = $this->getFilteredFilesystemContents($filesystem, $pattern);
+        }
+
+        if (key($this->fsContent) === null) {
+            $state->setSkipped(true);
+            $this->fsContent = null;
+        } else {
+            $state->setOutput(current($this->fsContent));
+        }
+    }
+
+    public function next(ProcessState $state)
+    {
+        if (!is_array($this->fsContent)) {
+            return false;
+        }
+
+        next($this->fsContent);
+
+        return key($this->fsContent) !== null;
+    }
+
+
+    /**
+     * @param FilesystemInterface $filesystem
+     * @param string|null         $pattern
+     *
+     * @return array
+     */
+    protected function getFilteredFilesystemContents(FilesystemInterface $filesystem, $pattern = null): array
+    {
+        $results = [];
+        foreach ($filesystem->listContents() as $item) {
+            if ($pattern === null || \preg_match($pattern, $item['path'])) {
+                $results[] = $item;
+            }
+        }
+
+        return $results;
+    }
+
+    /**
+     * @return MountManager
+     */
+    protected function getMountManager(): MountManager
+    {
+        return $this->mountManager;
+    }
+
+}

Task/RemoveFileTask.php

@@ -0,0 +1,68 @@
+<?php declare(strict_types=1);
+/**
+ * This file is part of the CleverAge/FlysystemProcessBundle package.
+ *
+ * Copyright (C) 2017-2019 Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\FlysystemProcessBundle\Task;
+
+use CleverAge\ProcessBundle\Model\AbstractConfigurableTask;
+use CleverAge\ProcessBundle\Model\ProcessState;
+use League\Flysystem\MountManager;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Remove a file from a filesystem
+ */
+class RemoveFileTask extends AbstractConfigurableTask
+{
+    use FilesystemOptionTrait;
+
+    /** @var  MountManager */
+    protected $mountManager;
+
+    /** @var LoggerInterface */
+    protected $logger;
+
+    /**
+     * RemoveFileTask constructor.
+     *
+     * @param MountManager    $mountManager
+     * @param LoggerInterface $logger
+     */
+    public function __construct(MountManager $mountManager, LoggerInterface $logger)
+    {
+        $this->mountManager = $mountManager;
+        $this->logger = $logger;
+    }
+
+    protected function configureOptions(OptionsResolver $resolver)
+    {
+        $this->configureFilesystemOption($resolver, 'filesystem');
+    }
+
+    public function execute(ProcessState $state)
+    {
+        $filesystem = $this->getFilesystem($state, 'filesystem');
+        $filePath = $state->getInput();
+
+        $success = $filesystem->delete($filePath);
+
+        if ($success) {
+            $this->logger->info('Deleted input file', ['file' => $filePath]);
+        } else {
+            $this->logger->warning('Failed to deleted input file', ['file' => $filePath]);
+        }
+    }
+
+    protected function getMountManager(): MountManager
+    {
+        return $this->mountManager;
+    }
+
+}