Added a pre upload event.

This event will be given an instance of UploadedFile instead of a moved file.
Addresses #21.

Author: sheeep

Controller/AbstractController.php

@@ -8,6 +8,7 @@
 use Symfony\Component\HttpFoundation\Request;
 
 use Oneup\UploaderBundle\UploadEvents;
+use Oneup\UploaderBundle\Event\PreUploadEvent;
 use Oneup\UploaderBundle\Event\PostPersistEvent;
 use Oneup\UploaderBundle\Event\PostUploadEvent;
 use Oneup\UploaderBundle\Event\ValidationEvent;
@@ -42,21 +43,38 @@ abstract public function upload();
      *  @param UploadedFile The file to upload
      *  @param response A response object.
      *  @param request The request object.
-     *
-     *  @return File the actual file
      */
     protected function handleUpload(UploadedFile $file, ResponseInterface $response, Request $request)
     {
         $this->validate($file);
 
+        $this->dispatchPreUploadEvent($file, $response, $request);
+
         // no error happend, proceed
         $namer = $this->container->get($this->config['namer']);
         $name  = $namer->name($file);
 
         // perform the real upload
         $uploaded = $this->storage->upload($file, $name);
 
-        $this->dispatchEvents($uploaded, $response, $request);
+        $this->dispatchPostEvents($uploaded, $response, $request);
+    }
+
+    /**
+     *  This function is a helper function which dispatches pre upload event
+     *
+     *  @param uploaded The uploaded file.
+     *  @param response A response object.
+     *  @param request The request object.
+     */
+    protected function dispatchPreUploadEvent(UploadedFile $uploaded, ResponseInterface $response, Request $request)
+    {
+        $dispatcher = $this->container->get('event_dispatcher');
+
+        // dispatch pre upload event (both the specific and the general)
+        $postUploadEvent = new PreUploadEvent($uploaded, $response, $request, $this->type, $this->config);
+        $dispatcher->dispatch(UploadEvents::PRE_UPLOAD, $postUploadEvent);
+        $dispatcher->dispatch(sprintf('%s.%s', UploadEvents::PRE_UPLOAD, $this->type), $postUploadEvent);
     }
 
     /**
@@ -67,7 +85,7 @@ protected function handleUpload(UploadedFile $file, ResponseInterface $response,
      *  @param response A response object.
      *  @param request The request object.
      */
-    protected function dispatchEvents($uploaded, ResponseInterface $response, Request $request)
+    protected function dispatchPostEvents($uploaded, ResponseInterface $response, Request $request)
     {
         $dispatcher = $this->container->get('event_dispatcher');
 

Event/PreUploadEvent.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Oneup\UploaderBundle\Event;
+
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\HttpFoundation\Request;
+use Oneup\UploaderBundle\Uploader\Response\ResponseInterface;
+
+class PreUploadEvent extends Event
+{
+    protected $file;
+    protected $request;
+    protected $type;
+    protected $response;
+    protected $config;
+
+    public function __construct($file, ResponseInterface $response, Request $request, $type, array $config)
+    {
+        $this->file = $file;
+        $this->request = $request;
+        $this->response = $response;
+        $this->type = $type;
+        $this->config = $config;
+    }
+
+    public function getFile()
+    {
+        return $this->file;
+    }
+
+    public function getRequest()
+    {
+        return $this->request;
+    }
+
+    public function getType()
+    {
+        return $this->type;
+    }
+
+    public function getResponse()
+    {
+        return $this->response;
+    }
+
+    public function getConfig()
+    {
+        return $this->config;
+    }
+}

Resources/doc/events.md

@@ -3,6 +3,7 @@ OneupUploaderBundle Events
 
 For a list of general Events, you can always have a look at the `UploadEvents.php` file in the root of this bundle.
 
+* `oneup_uploader.pre_upload` Will be fired after validation but before naming and moving the uploaded file.
 * `oneup_uploader.post_upload` Will be dispatched after a file has been uploaded and moved.
 * `oneup_uploader.post_persist` The same as `oneup_uploader.post_upload` but will only be dispatched if no `Orphanage` is used.
 
@@ -12,8 +13,10 @@ In case you are using chunked uploads on your frontend, you can listen to:
 
 Moreover this bundles also dispatches some special kind of generic events you can listen to.
 
+* `oneup_uploader.pre_upload.{mapping}`
 * `oneup_uploader.post_upload.{mapping}`
 * `oneup_uploader.post_persist.{mapping}`
+* `oneup_uploader.post_chunk_upload.{mapping}`
 
 The `{mapping}` part is the key of your configured mapping. The examples in this documentation always uses the mapping key `gallery`. So the dispatched event would be called `oneup_uploader.post_upload.gallery`.
 Using these generic events can save you some time and coding lines, as you don't have to check for the correct type in the `EventListener`.

Tests/Controller/AbstractUploadTest.php

@@ -4,6 +4,7 @@
 
 use Oneup\UploaderBundle\Tests\Controller\AbstractControllerTest;
 use Oneup\UploaderBundle\UploadEvents;
+use Oneup\UploaderBundle\Event\PreUploadEvent;
 use Oneup\UploaderBundle\Event\PostUploadEvent;
 
 abstract class AbstractUploadTest extends AbstractControllerTest
@@ -47,9 +48,19 @@ public function testEvents()
         // event data
         $me = $this;
         $uploadCount = 0;
+        $preValidation = 1;
+        
+        $dispatcher->addListener(UploadEvents::PRE_UPLOAD, function(PreUploadEvent $event) use (&$uploadCount, &$me, &$preValidation) {
+            $preValidation -= 2;
 
-        $dispatcher->addListener(UploadEvents::POST_UPLOAD, function(PostUploadEvent $event) use (&$uploadCount, &$me) {
+            $file = $event->getFile();
+
+            $me->assertInstanceOf('Symfony\Component\HttpFoundation\File\UploadedFile', $file);
+        });
+
+        $dispatcher->addListener(UploadEvents::POST_UPLOAD, function(PostUploadEvent $event) use (&$uploadCount, &$me, &$preValidation) {
             ++ $uploadCount;
+            $preValidation *= -1;
 
             $file = $event->getFile();
 
@@ -61,5 +72,6 @@ public function testEvents()
 
         $this->assertCount(1, $this->getUploadedFiles());
         $this->assertEquals($uploadCount, count($this->getUploadedFiles()));
+        $this->assertEquals(1, $preValidation);
     }
 }

UploadEvents.php

@@ -4,8 +4,9 @@
 
 final class UploadEvents
 {
-    const POST_PERSIST      = 'oneup_uploader.post_persist';
+    const PRE_UPLOAD        = 'oneup_uploader.pre_upload';
     const POST_UPLOAD       = 'oneup_uploader.post_upload';
+    const POST_PERSIST      = 'oneup_uploader.post_persist';
     const POST_CHUNK_UPLOAD = 'oneup_uploader.post_chunk_upload';
     const VALIDATION        = 'oneup_uploader.validation';
 }