Merge pull request #1 from frozenminds/feature/event-virus-detection

Dispatch an event when virus is uploaded
Evozon-PHP · Nov 20, 2018 · 575416d · 575416d
2 parents 9ff9486 + 295da90
commit 575416d
Show file tree

Hide file tree

Showing 7 changed files with 96 additions and 4 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -85,7 +85,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->validate()
                         ->ifArray()
                         ->then(function ($v) {
-                            if ($v['alias'] === 'clamavphp' && !class_exists('\CL\Tissue\Adapter\ClamAVPHP\ClamAVPHPAdapter')) {
+                            if ('clamavphp' === $v['alias'] && !class_exists('\CL\Tissue\Adapter\ClamAVPHP\ClamAVPHPAdapter')) {
                                 throw new InvalidConfigurationException('If you want to use the `clamavphp` adapter, you need to add the `cleentfaar/tissue-clamavphp-adapter` package to your composer.json');
                             }
 

diff --git a/DependencyInjection/TissueExtension.php b/DependencyInjection/TissueExtension.php
@@ -45,7 +45,7 @@ private function setParameters(array $config, ContainerBuilder $container)
         }
 
         foreach ($config['adapter'] as $key => $val) {
-            if ($key === 'options') {
+            if ('options' === $key) {
                 foreach ($val as $k => $v) {
                     $container->setParameter(sprintf('tissue.adapter.options.%s', $k), $v);
                 }

diff --git a/Event/DetectionVirusEvent.php b/Event/DetectionVirusEvent.php
@@ -0,0 +1,58 @@
+<?php
+
+namespace CL\Bundle\TissueBundle\Event;
+
+use CL\Bundle\TissueBundle\Validator\Constraints\CleanFile;
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\HttpFoundation\File\UploadedFile;
+
+/**
+ * Virus Detection Event.
+ *
+ * @copyright Evozon Systems SRL (http://www.evozon.com/)
+ * @author    Constantin Bejenaru <constantin.bejenaru@evozon.com>
+ */
+class DetectionVirusEvent extends Event
+{
+    /**
+     * @var UploadedFile
+     */
+    private $uploadedFile;
+
+    /**
+     * @var CleanFile
+     */
+    private $constraint;
+
+    /**
+     * Constructor.
+     *
+     * @param UploadedFile $uploadedFile
+     * @param CleanFile    $constraint
+     */
+    public function __construct(UploadedFile $uploadedFile, CleanFile $constraint)
+    {
+        $this->uploadedFile = $uploadedFile;
+        $this->constraint = $constraint;
+    }
+
+    /**
+     * Get UploadedFile.
+     *
+     * @return UploadedFile
+     */
+    public function getUploadedFile(): UploadedFile
+    {
+        return $this->uploadedFile;
+    }
+
+    /**
+     * Get Constraint.
+     *
+     * @return CleanFile
+     */
+    public function getConstraint(): CleanFile
+    {
+        return $this->constraint;
+    }
+}
diff --git a/Events.php b/Events.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace CL\Bundle\TissueBundle;
+
+/**
+ * Events.
+ *
+ * @copyright Evozon Systems SRL (http://www.evozon.com/)
+ * @author    Constantin Bejenaru <constantin.bejenaru@evozon.com>
+ */
+final class Events
+{
+    /**
+     * Dispatched when a virus detection is found during an upload file validation.
+     */
+    const DETECTION_VIRUS = 'tissue.detection.virus';
+}
diff --git a/Resources/config/services.yml b/Resources/config/services.yml
@@ -14,6 +14,7 @@ services:
 
   CL\Bundle\TissueBundle\Validator\Constraints\CleanFileValidator:
     arguments:
+      - "@event_dispatcher"
       - "@tissue.scanner"
     tags:
       - { name: validator.constraint_validator, alias: clean_file }
diff --git a/Validator/Constraints/CleanFileValidator.php b/Validator/Constraints/CleanFileValidator.php
@@ -11,7 +11,10 @@
 
 namespace CL\Bundle\TissueBundle\Validator\Constraints;
 
+use CL\Bundle\TissueBundle\Event\DetectionVirusEvent;
+use CL\Bundle\TissueBundle\Events;
 use CL\Tissue\Adapter\AdapterInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\Constraints\FileValidator;
@@ -22,16 +25,25 @@
  */
 class CleanFileValidator extends FileValidator
 {
+    /**
+     * @var EventDispatcherInterface
+     */
+    private $eventDispatcher;
+
     /**
      * @var AdapterInterface|null
      */
     private $adapter;
 
     /**
-     * @param AdapterInterface|null $adapter
+     * Constructor.
+     *
+     * @param EventDispatcherInterface $eventDispatcher
+     * @param AdapterInterface|null    $adapter
      */
-    public function __construct(AdapterInterface $adapter = null)
+    public function __construct(EventDispatcherInterface $eventDispatcher, ?AdapterInterface $adapter)
     {
+        $this->eventDispatcher = $eventDispatcher;
         $this->adapter = $adapter;
     }
 
@@ -57,6 +69,9 @@ public function validate($value, Constraint $constraint): void
             }
             $this->context->buildViolation($constraint->virusDetectedMessage)->addViolation();
 
+            $event = new DetectionVirusEvent($value, $constraint);
+            $this->eventDispatcher->dispatch(Events::DETECTION_VIRUS, $event);
+
             return;
         }
 

diff --git a/composer.json b/composer.json
@@ -22,6 +22,7 @@
     "symfony/symfony": "^3.0 || ^4.0",
     "symfony/options-resolver": "^3.0 || ^4.0",
     "symfony/validator": "^3.0 || ^4.0",
+    "symfony/event-dispatcher": "^3.0 || ^4.0",
     "evozon-php/tissue": "*",
     "evozon-php/tissue-clamav-adapter": "*"
   },