UploadFileHelper - change api to support multiple files

Editor/Helper/UploadCkeditorHelper.php

@@ -10,9 +10,15 @@ class UploadCkeditorHelper extends UploadDefaultHelper
     /**
      * {@inheritdoc}
      */
-    public function getUploadResponse(Request $request, FileInterface $file)
+    public function getUploadResponse(Request $request, array $files)
     {
-        $urlSafePath = $this->mediaManager->getUrlSafePath($file);
+        if (!isset($files[0]) && !$files[0] instanceof FileInterface) {
+            throw new \InvalidArgumentException(
+                'Provide at least one Symfony\Cmf\Bundle\MediaBundle\FileInterface file.'
+            );
+        }
+
+        $urlSafePath = $this->mediaManager->getUrlSafePath($files[0]);
         $url         = $this->router->generate('cmf_media_image_display', array('path' => $urlSafePath));
         $funcNum     = $request->query->get('CKEditorFuncNum');
 

Editor/Helper/UploadDefaultHelper.php

@@ -4,6 +4,7 @@
 
 use Symfony\Cmf\Bundle\MediaBundle\Editor\UploadEditorHelperInterface;
 use Symfony\Cmf\Bundle\MediaBundle\FileInterface;
+use Symfony\Cmf\Bundle\MediaBundle\ImageInterface;
 use Symfony\Cmf\Bundle\MediaBundle\MediaManagerInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -45,10 +46,20 @@ public function setFileDefaults(Request $request, FileInterface $file)
     /**
      * {@inheritdoc}
      */
-    public function getUploadResponse(Request $request, FileInterface $file)
+    public function getUploadResponse(Request $request, array $files)
     {
-        $urlSafePath = $this->mediaManager->getUrlSafePath($file);
+        if (!isset($files[0]) && !$files[0] instanceof FileInterface) {
+            throw new \InvalidArgumentException(
+                'Provide at least one Symfony\Cmf\Bundle\MediaBundle\FileInterface file.'
+            );
+        }
+
+        $urlSafePath = $this->mediaManager->getUrlSafePath($files[0]);
 
-        return new RedirectResponse($this->router->generate('cmf_media_image_display', array('path' => $urlSafePath)));
+        if ($files[0] instanceof ImageInterface) {
+            return new RedirectResponse($this->router->generate('cmf_media_image_display', array('path' => $urlSafePath)));
+        } else {
+            return new RedirectResponse($request->headers->get('referer'));
+        }
     }
 }

Editor/UploadEditorHelperInterface.php

@@ -23,7 +23,12 @@ public function setFileDefaults(Request $request, FileInterface $file);
     /**
      * Get a response for the upload action of the editor
      *
+     * @param Request $request
+     * @param FileInterface[] $files
+     *
      * @return Response
+     *
+     * @throws InvalidArgumentException if no FileInterface file is provided
      */
-    public function getUploadResponse(Request $request, FileInterface $file);
+    public function getUploadResponse(Request $request, array $files);
 }

File/UploadFileHelper.php

@@ -125,14 +125,43 @@ protected function validateFile(UploadedFile $file)
         return true;
     }
 
+    /**
+     * Handle the UploadedFile and create a FileInterface object specified by
+     * the configured class.
+     *
+     * @param Request      $request
+     * @param UploadedFile $uploadedFile
+     *
+     * @return FileInterface
+     */
+    public function handleUploadedFile(UploadedFile $uploadedFile)
+    {
+        $this->validateFile($uploadedFile);
+
+        /** @var $file FileInterface */
+        $file = new $this->class;
+        $file->setName($uploadedFile->getClientOriginalName());
+        $file->copyContentFromFile($uploadedFile);
+
+        try {
+            $this->mediaManager->setDefaults($file, $this->rootPath);
+        } catch (\RuntimeException $e) {
+            throw new HttpException(409, $e->getMessage());
+        }
+
+        return $file;
+    }
+
     /**
      * Process upload and get a response
      *
-     * @param Request $request
+     * @param Request        $request
+     * @param UploadedFile[] $uploadedFiles optionally get the uploaded file(s)
+     *      from the Request yourself
      *
      * @return Response
      */
-    public function getUploadResponse(Request $request)
+    public function getUploadResponse(Request $request, array $uploadedFiles = array())
     {
         /** @var \Symfony\Cmf\Bundle\MediaBundle\Editor\EditorHelperInterface $editorHelper */
         $editorHelper = $this->getEditorHelper($request->get('editor', 'default'));
@@ -144,30 +173,27 @@ public function getUploadResponse(Request $request)
             ));
         }
 
-        $files = $request->files;
+        if (count($uploadedFiles) === 0) {
+            // by default get the first file
+            $uploadedFiles = array($request->files->getIterator()->current());
+        }
 
-        /** @var $file UploadedFile */
-        $uploadedFile = $files->getIterator()->current();
-        $this->validateFile($uploadedFile);
+        // handle the uploaded file(s)
+        $files = array();
+        foreach ($uploadedFiles as $uploadedFile) {
+            $file = $this->handleUploadedFile($uploadedFile);
 
-        /** @var $image FileInterface */
-        $file = new $this->class;
-        $file->setName($uploadedFile->getClientOriginalName());
-        $file->copyContentFromFile($uploadedFile);
+            $editorHelper->setFileDefaults($request, $file);
 
-        $editorHelper->setFileDefaults($request, $file);
+            $this->getObjectManager()->persist($file);
 
-        try {
-            $this->mediaManager->setDefaults($file, $this->rootPath);
-        } catch (\RuntimeException $e) {
-            throw new HttpException(409, $e->getMessage());
+            $files[] = $file;
         }
 
-        // persist
-        $this->getObjectManager()->persist($file);
+        // write created FileInterface file(s) to storage
         $this->getObjectManager()->flush();
 
         // response
-        return $editorHelper->getUploadResponse($request, $file);
+        return $editorHelper->getUploadResponse($request, $files);
     }
 }

Resources/config/routing/file.xml

@@ -10,7 +10,7 @@
         <requirement key="path">.*</requirement>
     </route>
 
-    <route id="cmf_media_upload" pattern="/media/upload/{editor}">
+    <route id="cmf_media_file_upload" pattern="/media/file/upload/{editor}">
         <default key="_controller">cmf_media.file.controller:uploadAction</default>
         <default key="editor">default</default>
         <default key="_format">json</default>

Resources/config/routing/image.xml

@@ -10,4 +10,11 @@
         <requirement key="path">.*</requirement>
     </route>
 
+    <route id="cmf_media_image_upload" pattern="/media/image/upload/{editor}">
+        <default key="_controller">cmf_media.image.controller:uploadAction</default>
+        <default key="editor">default</default>
+        <default key="_format">json</default>
+        <requirement key="_method">POST</requirement>
+    </route>
+
 </routes>

Tests/Resources/Controller/PhpcrFileTestController.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\MediaBundle\Tests\Resources\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Cmf\Bundle\MediaBundle\File\UploadFileHelper;
+use Symfony\Component\HttpFoundation\Request;
+
+class PhpcrFileTestController extends Controller
+{
+    public function getUploadForm($editor = null)
+    {
+        if ($editor) {
+            $action = $this->generateUrl('cmf_media_file_upload', array('editor' => $editor));
+        } else {
+            $action = $this->generateUrl('phpcr_file_test_upload');
+        }
+
+        return $this->container->get('form.factory')->createNamedBuilder(null, 'form', null, array('action' => $action))
+            ->add('file', 'file')
+            ->add('submit', 'submit')
+            ->getForm()
+        ;
+    }
+
+    public function fileAction(Request $request)
+    {
+        $fileClass = 'Symfony\Cmf\Bundle\MediaBundle\Doctrine\Phpcr\File';
+        $dm        = $this->get('doctrine_phpcr')->getManager('default');
+        $files     = $dm->getRepository($fileClass)->findAll();
+
+        $uploadForm = $this->getUploadForm();
+        $editorUploadForm = $this->getUploadForm('default');
+
+        return $this->render('::tests/file.html.twig', array(
+            'upload_form'  => $uploadForm->createView(),
+            'editor_form'  => $editorUploadForm->createView(),
+            'files' => $files,
+        ));
+    }
+
+    public function uploadAction(Request $request)
+    {
+        $form = $this->getUploadForm();
+        $form->handleRequest($request);
+
+        if ($form->isValid()) {
+            /** @var UploadFileHelper $uploadFileHelper */
+            $uploadFileHelper = $this->get('cmf_media.upload_file_helper');
+
+            $uploadedFile = $request->files->get('file');
+
+            $file = $uploadFileHelper->handleUploadedFile($uploadedFile);
+
+            // persist
+            $dm = $this->get('doctrine_phpcr')->getManager('default');
+            $dm->persist($file);
+            $dm->flush();
+        }
+
+        return $this->redirect($this->generateUrl('phpcr_file_test'));
+    }
+}

Tests/Resources/Controller/TestController.php

@@ -7,21 +7,8 @@
 
 class TestController extends Controller
 {
-    private $fileClass = 'Symfony\Cmf\Bundle\MediaBundle\Doctrine\Phpcr\File';
-
     public function indexAction(Request $request)
     {
         return $this->render('::index.html.twig');
     }
-
-    public function fileAction(Request $request)
-    {
-        $files = $this->get('doctrine_phpcr')
-            ->getRepository($this->fileClass)
-            ->findAll();
-
-        return $this->render('::tests/file.html.twig', array(
-            'files' => $files,
-        ));
-    }
 }

Tests/Resources/DataFixtures/Phpcr/LoadMediaData.php

@@ -1,14 +1,14 @@
 <?php
 
-namespace Symfony\Cmf\Bundle\MediaBundle\Tests\Resources\DataFixtures\Phpcr;
+namespace Symfony\Cmf\Bundle\MediaBundle\Tests\Resources\DataFixtures\PHPCR;
 
 use Doctrine\Common\DataFixtures\DependentFixtureInterface;
 use Doctrine\Common\DataFixtures\FixtureInterface;
 use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\ODM\PHPCR\Document\Generic;
 use Symfony\Cmf\Bundle\MediaBundle\Doctrine\Phpcr\File;
 
-class LoadBlockData implements FixtureInterface, DependentFixtureInterface
+class LoadMediaData implements FixtureInterface, DependentFixtureInterface
 {
     public function getDependencies()
     {
@@ -19,11 +19,15 @@ public function getDependencies()
 
     public function load(ObjectManager $manager)
     {
-        $root = $manager->find(null, '/test/media');
+        $root = $manager->find(null, '/test');
+        $mediaRoot = new Generic;
+        $mediaRoot->setNodename('media');
+        $mediaRoot->setParent($root);
+        $manager->persist($mediaRoot);
 
         // File
         $file = new File();
-        $file->setParent($root);
+        $file->setParent($mediaRoot);
         $file->setName('file-1.txt');
         $file->setContentFromString('Test file 1.');
         $file->setContentType('text/plain');

Tests/Resources/app/Resources/data/testfile.txt

@@ -0,0 +1 @@
+This is a test file used to test uploads.

Tests/Resources/app/Resources/views/index.html.twig

@@ -1,8 +1,9 @@
 {% extends "::layout.html.twig" %}
 {% block content %}
 <h2>Tests</h2>
+<h3>Phpcr</h3>
 <ul>
-    <li><a href="{{ path('file_test') }}">File test</a></li>
+    <li><a href="{{ path('phpcr_file_test') }}">File test</a></li>
 </ul>
 <h2>About</h2>
 <p>This test application is built into the MediaBundle. You can easily run

Tests/Resources/app/Resources/views/tests/file.html.twig

@@ -1,9 +1,24 @@
 {% extends "::layout.html.twig" %}
 {% block content %}
-<h2>Download file</h2>
-<ul>
-    {% for file in files %}
-    <li><a href="{{ cmf_media_download_url(file) }}" title="Download {{ file.name }}">Download {{ file.name }}</a></li>
-    {% endfor %}
-</ul>
+<h2>Upload file</h2>
+<h4>Standard upload</h4>
+<p>The upload is handled by your own controller action. The UploadFileHelper is used to handle the upload and creates a
+    FileInterface object, writing the object to storage has to be implemented by yourself.</p>
+{{ form(upload_form, { attr: { class: 'standard' } }) }}
+<h4>Web editor upload (default)</h4>
+<p>The upload is completely handled by the FileController::uploadAction. The UploadFileHelper will process the upload,
+    writes the created FileInterface object to storage and returns a response that depends on the editor defined in the
+    request.</p>
+{{ form(editor_form, { attr: { class: 'editor default' } }) }}
+
+<h2>Download file(s)</h2>
+{% if files is empty %}
+    <p>No files found, upload a file first.</p>
+{% else %}
+    <ul class="downloads">
+        {% for file in files %}
+        <li><a href="{{ cmf_media_download_url(file) }}" title="Download {{ file.name }}">Download {{ file.name }}</a></li>
+        {% endfor %}
+    </ul>
+{% endif %}
 {% endblock %}

Tests/Resources/app/config/config.php

@@ -3,3 +3,4 @@
 $loader->import(CMF_TEST_CONFIG_DIR . '/default.php');
 $loader->import(CMF_TEST_CONFIG_DIR . '/phpcr_odm.php');
 $loader->import(__DIR__.'/cmf_media.yml');
+$loader->import(__DIR__.'/security.yml');

Tests/Resources/app/config/routing/cmf_media.yml

@@ -3,10 +3,20 @@ test_index:
     defaults:
         _controller: Symfony\Cmf\Bundle\MediaBundle\Tests\Resources\Controller\TestController::indexAction
 
-file_test:
-    pattern: /file-test
+phpcr_file_test:
+    pattern: /phpcr/file-test
     defaults:
-        _controller: Symfony\Cmf\Bundle\MediaBundle\Tests\Resources\Controller\TestController::fileAction
+        _controller: Symfony\Cmf\Bundle\MediaBundle\Tests\Resources\Controller\PhpcrFileTestController::fileAction
+
+phpcr_file_test_upload:
+    pattern: /phpcr/file-test/upload
+    defaults:
+        _controller: Symfony\Cmf\Bundle\MediaBundle\Tests\Resources\Controller\PhpcrFileTestController::uploadAction
+
+phpcr_file_test_upload_editor:
+    pattern: /phpcr/file-test/upload/editor
+    defaults:
+        _controller: Symfony\Cmf\Bundle\MediaBundle\Tests\Resources\Controller\PhpcrFileTestController::editorUploadAction
 
 cmf_media_file:
     resource: "@CmfMediaBundle/Resources/config/routing/file.xml"

Tests/Resources/app/config/security.yml

@@ -0,0 +1,4 @@
+security:
+    role_hierarchy:
+        ROLE_ADMIN:       [ROLE_USER, ROLE_CAN_UPLOAD_FILE]
+        ROLE_SUPER_ADMIN: [ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]