Rewrite the DCA picker (see contao#950).

CHANGELOG.md

@@ -2,13 +2,12 @@
 
 ### DEV
 
- * Eliminate nested paths when deleting folders in the file manager (see #941).
- * Do not generate duplicate form IDs (see contao/core#8538).
+ * Rewrite the DCA picker (see #950).
 
 ### 4.4.1 (2017-07-12)
 
  * Prevent arbitrary PHP file inclusions in the back end (see CVE-2017-10993).
- * Correctly handle subpalettes in "edit multiple" mode (see #946). 
+ * Correctly handle subpalettes in "edit multiple" mode (see #946).
  * Correctly show the DCA picker in the site structure (see #906).
  * Correctly update the style sheets if a format definition is enabled/disabled (see #893).
  * Always show the "show from" and "show until" fields (see #908).

src/ContaoCoreBundle.php

@@ -15,7 +15,7 @@
 use Contao\CoreBundle\DependencyInjection\Compiler\AddResourcesPathsPass;
 use Contao\CoreBundle\DependencyInjection\Compiler\AddSessionBagsPass;
 use Contao\CoreBundle\DependencyInjection\Compiler\DoctrineMigrationsPass;
-use Contao\CoreBundle\DependencyInjection\Compiler\PickerMenuProviderPass;
+use Contao\CoreBundle\DependencyInjection\Compiler\PickerProviderPass;
 use Contao\CoreBundle\DependencyInjection\ContaoCoreExtension;
 use Symfony\Component\Console\Application;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -63,6 +63,6 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new AddResourcesPathsPass());
         $container->addCompilerPass(new AddImagineClassPass());
         $container->addCompilerPass(new DoctrineMigrationsPass());
-        $container->addCompilerPass(new PickerMenuProviderPass());
+        $container->addCompilerPass(new PickerProviderPass());
     }
 }

src/Controller/BackendController.php

@@ -21,11 +21,13 @@
 use Contao\BackendPopup;
 use Contao\BackendPreview;
 use Contao\BackendSwitch;
+use Contao\CoreBundle\Picker\PickerConfig;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
 /**
  * Handles the Contao backend routes.
@@ -214,18 +216,36 @@ public function alertsAction()
     }
 
     /**
-     * Handles the picker redirect.
+     * Redirects the user to the Contao back end and includes the picker query parameter. It will determine
+     * the current provider URL based on the value (usually read dynamically via JavaScript).
      *
      * @param Request $request
      *
+     * @throws BadRequestHttpException
+     *
      * @return RedirectResponse
      *
      * @Route("/_contao/picker", name="contao_backend_picker")
      */
     public function pickerAction(Request $request)
     {
-        $pickerBuilder = $this->container->get('contao.menu.picker_menu_builder');
+        $extras = [];
+
+        if ($request->query->has('extras')) {
+            $extras = $request->query->get('extras');
+
+            if (!is_array($extras)) {
+                throw new BadRequestHttpException('Invalid picker extras');
+            }
+        }
+
+        $config = new PickerConfig($request->query->get('context'), $extras, $request->query->get('value'));
+        $picker = $this->container->get('contao.picker.builder')->create($config);
+
+        if (null === $picker) {
+            throw new BadRequestHttpException('Unsupported picker context');
+        }
 
-        return new RedirectResponse($pickerBuilder->getPickerUrl($request));
+        return new RedirectResponse($picker->getCurrentUrl());
     }
 }

src/DependencyInjection/Compiler/PickerMenuProviderPass.php → src/DependencyInjection/Compiler/PickerProviderPass.php

@@ -15,11 +15,12 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * Registers the picker menu providers.
+ * Registers the picker providers.
  *
  * @author Leo Feyer <https://github.com/leofeyer>
+ * @author Andreas Schempp <https://github.com/aschempp>
  */
-class PickerMenuProviderPass implements CompilerPassInterface
+class PickerProviderPass implements CompilerPassInterface
 {
     use PriorityTaggedServiceTrait;
 
@@ -28,12 +29,12 @@ class PickerMenuProviderPass implements CompilerPassInterface
      */
     public function process(ContainerBuilder $container)
     {
-        if (!$container->has('contao.menu.picker_menu_builder')) {
+        if (!$container->has('contao.picker.builder')) {
             return;
         }
 
-        $definition = $container->findDefinition('contao.menu.picker_menu_builder');
-        $references = $this->findAndSortTaggedServices('contao.picker_menu_provider', $container);
+        $definition = $container->findDefinition('contao.picker.builder');
+        $references = $this->findAndSortTaggedServices('contao.picker_provider', $container);
 
         foreach ($references as $reference) {
             $definition->addMethodCall('addProvider', [$reference]);

src/DependencyInjection/ContaoCoreExtension.php

@@ -10,7 +10,7 @@
 
 namespace Contao\CoreBundle\DependencyInjection;
 
-use Contao\CoreBundle\Menu\PickerMenuProviderInterface;
+use Contao\CoreBundle\Picker\PickerProviderInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
@@ -90,8 +90,8 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $this->overwriteImageTargetDir($mergedConfig, $container);
 
         $container
-            ->registerForAutoconfiguration(PickerMenuProviderInterface::class)
-            ->addTag('contao.picker_menu_provider')
+            ->registerForAutoconfiguration(PickerProviderInterface::class)
+            ->addTag('contao.picker_provider')
         ;
     }