port features from simple cms into routing bundle to simplify things

Admin/RouteAdmin.php

@@ -66,8 +66,6 @@ protected function configureFormFields(FormMapper $formMapper)
                 array('choice_list' => array(), 'select_root_node' => true, 'root_node' => $this->routeRoot)
             )
             ->add('name', 'text')
-            ->add('addFormatPattern', null, array('required' => false, 'help' => 'form.help_add_format_pattern'))
-            ->add('addTrailingSlash', null, array('required' => false, 'help' => 'form.help_add_trailing_slash'))
         ->end();
 
         if (null === $this->getParentFieldDescription()) {
@@ -76,6 +74,7 @@ protected function configureFormFields(FormMapper $formMapper)
                 ->add('variablePattern', 'text', array('required' => false))
                 ->add('content', 'doctrine_phpcr_odm_tree', array('choice_list' => array(), 'required' => false, 'root_node' => $this->contentRoot))
                 ->add('defaults', 'sonata_type_immutable_array', array('keys' => $this->configureFieldsForDefaults()))
+                ->add('options', 'sonata_type_immutable_array', array('keys' => $this->configureFieldsForOptions()))
             ->end();
         }
     }
@@ -110,7 +109,7 @@ public function getExportFormats()
 
     protected function configureFieldsForDefaults()
     {
-        $defaults =  array(
+        $defaults = array(
             '_controller' => array('_controller', 'text', array('required' => false)),
             '_template' => array('_template', 'text', array('required' => false)),
             'type' => array('type', 'cmf_routing_route_type', array(
@@ -125,7 +124,7 @@ protected function configureFieldsForDefaults()
                 $defaults[$name] = array($name, 'text', array('required' => false));
             }
         }
-        
+
         //parse variable pattern and add defaults for it - taken from routecompiler
         /** @var $route Route */
         $route =  $this->subject;
@@ -142,6 +141,23 @@ protected function configureFieldsForDefaults()
         return $defaults;
     }
 
+    protected function configureFieldsForOptions()
+    {
+        $options = array(
+            'addFormatPattern' => array('addFormatPattern', 'text', array('required' => false), array('help' => 'form.help_add_format_pattern')),
+            'addTrailingSlash' => array('addTrailingSlash', 'text', array('required' => false), array('help' => 'form.help_add_trailing_slash')),
+        );
+
+        $dynamicOptions = $this->getSubject()->getOptions();
+        foreach ($dynamicOptions as $name => $value) {
+            if (!isset($options[$name])) {
+                $options[$name] = array($name, 'text', array('required' => false));
+            }
+        }
+
+        return $options;
+    }
+
     public function prePersist($object)
     {
         $defaults = array_filter($object->getDefaults());

CHANGELOG.md

@@ -1,15 +1,19 @@
 Changelog
 =========
 
+* **2014-03-26**: [ORM] Applied the cleanup for the PHPCR provider to the ORM
+  provider now: If the route matched a pattern with a format extension, the
+  format extension is no longer set as route a default.
+
 * **2014-03-25**: setParent() and getParent() are now deprecated.
   Use setParentDocument() and getParentDocument() instead.
   Moreover, you should now enable the ChildExtension from the CoreBundle.
 
 * **2014-03-23**: When using PHPCR-ODM, routes can now be generated with their
   uuid as route name as well, in addition to the repository path.
 
-* **2013-11-28**: [BC BREAK] the alias attribute of the <template-by-class> is
-  renamed to class in the bundle configuration.
+* **2013-11-28**: [BC BREAK for xml configuration] the alias attribute of the
+  <template-by-class> is renamed to class in the bundle configuration.
 
 1.1.0
 -----

DependencyInjection/CmfRoutingExtension.php

@@ -95,9 +95,10 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         $container->setParameter($this->getAlias() . '.route_collection_limit', $config['route_collection_limit']);
 
         $locales = false;
-        if (isset($config['locales'])) {
+        if (!empty($config['locales'])) {
             $locales = $config['locales'];
             $container->setParameter($this->getAlias() . '.dynamic.locales', $locales);
+            $container->setParameter($this->getAlias() . '.dynamic.auto_locale_pattern', $config['auto_locale_pattern']);
         }
 
         $loader->load('routing-dynamic.xml');
@@ -109,13 +110,13 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         }
 
         if ($config['persistence']['phpcr']['enabled']) {
-            $this->loadPhpcrProvider($config['persistence']['phpcr'], $loader, $container, $locales);
+            $this->loadPhpcrProvider($config['persistence']['phpcr'], $loader, $container, $locales, $config['match_implicit_locale']);
             $hasProvider = true;
             $hasContentRepository = true;
         }
 
         if ($config['persistence']['orm']['enabled']) {
-            $this->loadOrmProvider($config['persistence']['orm'], $loader, $container);
+            $this->loadOrmProvider($config['persistence']['orm'], $loader, $container, $locales, $config['match_implicit_locale']);
             $hasProvider = true;
         }
 
@@ -226,22 +227,41 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         }
     }
 
-    public function loadPhpcrProvider($config, XmlFileLoader $loader, ContainerBuilder $container, $locales)
+    public function loadPhpcrProvider($config, XmlFileLoader $loader, ContainerBuilder $container, $locales, $matchImplicitLocale)
     {
         $loader->load('provider-phpcr.xml');
 
         $container->setParameter($this->getAlias() . '.backend_type_phpcr', true);
 
-        $container->setParameter($this->getAlias() . '.dynamic.persistence.phpcr.route_basepath', $config['route_basepath']);
-        $container->setParameter($this->getAlias() . '.dynamic.persistence.phpcr.content_basepath', $config['content_basepath']);
-
-        $container->setParameter($this->getAlias() . '.dynamic.persistence.phpcr.manager_name', $config['manager_name']);
-
-        $container->setAlias($this->getAlias() . '.route_provider', $this->getAlias() . '.phpcr_route_provider');
-        $container->setAlias($this->getAlias() . '.content_repository', $this->getAlias() . '.phpcr_content_repository');
+        $container->setParameter(
+            $this->getAlias() . '.dynamic.persistence.phpcr.route_basepaths',
+            $config['route_basepaths']
+        );
+        $container->setParameter(
+            $this->getAlias() . '.dynamic.persistence.phpcr.content_basepath',
+            $config['content_basepath']
+        );
+
+        $container->setParameter(
+            $this->getAlias() . '.dynamic.persistence.phpcr.manager_name',
+            $config['manager_name']
+        );
+
+        $container->setAlias(
+            $this->getAlias() . '.route_provider',
+            $this->getAlias() . '.phpcr_route_provider'
+        );
+        $container->setAlias(
+            $this->getAlias() . '.content_repository',
+            $this->getAlias() . '.phpcr_content_repository'
+        );
 
         if (!$locales) {
             $container->removeDefinition($this->getAlias() . '.phpcrodm_route_locale_listener');
+        } elseif (!$matchImplicitLocale) {
+            // remove all but the prefixes configuration from the service definition.
+            $definition = $container->getDefinition($this->getAlias() . '.phpcr_candidates_prefix');
+            $definition->setArguments(array($definition->getArgument(0)));
         }
 
         if ($config['use_sonata_admin']) {
@@ -256,14 +276,25 @@ public function loadSonataPhpcrAdmin($config, XmlFileLoader $loader, ContainerBu
             return;
         }
 
+        $basePath = empty($config['admin_basepath']) ? reset($config['route_basepaths']) : $config['admin_basepath'];
+
+        $container->setParameter($this->getAlias() . '.dynamic.persistence.phpcr.admin_basepath', $basePath);
+
+
         $loader->load('admin-phpcr.xml');
     }
 
-    public function loadOrmProvider($config, XmlFileLoader $loader, ContainerBuilder $container)
+    public function loadOrmProvider($config, XmlFileLoader $loader, ContainerBuilder $container, $matchImplicitLocale)
     {
         $container->setParameter($this->getAlias() . '.dynamic.persistence.orm.manager_name', $config['manager_name']);
         $container->setParameter($this->getAlias() . '.backend_type_orm', true);
         $loader->load('provider-orm.xml');
+
+        if (!$matchImplicitLocale) {
+            // remove the locales argument from the candidates
+            $definition = $container->getDefinition($this->getAlias() . '.orm_candidates');
+            $definition->setArguments(array());
+        }
     }
 
     /**

DependencyInjection/Configuration.php

@@ -77,9 +77,32 @@ public function getConfigTreeBuilder()
                                 ->arrayNode('phpcr')
                                     ->addDefaultsIfNotSet()
                                     ->canBeEnabled()
+                                    ->fixXmlConfig('route_basepath')
+                                    ->beforeNormalization()
+                                        ->ifTrue(function ($v) {
+                                            return isset($v['route_basepath']);
+                                        })
+                                        ->then(function ($v) {
+                                            $base = isset($v['route_basepaths']) ? $v['route_basepaths'] : array();
+                                            if (is_array($v['route_basepath'])) {
+                                                // xml configuration
+                                                $base += $v['route_basepath'];
+                                            } else {
+                                                $base[] = $v['route_basepath'];
+                                            }
+                                            $v['route_basepaths'] = array_unique($base);
+                                            unset($v['route_basepath']);
+
+                                            return $v;
+                                        })
+                                    ->end()
                                     ->children()
                                         ->scalarNode('manager_name')->defaultNull()->end()
-                                        ->scalarNode('route_basepath')->defaultValue('/cms/routes')->end()
+                                        ->arrayNode('route_basepaths')
+                                            ->prototype('scalar')->end()
+                                            ->defaultValue(array('/cms/routes'))
+                                        ->end()
+                                        ->scalarNode('admin_basepath')->end()
                                         ->scalarNode('content_basepath')->defaultValue('/cms/content')->end()
                                         ->enumNode('use_sonata_admin')
                                             ->beforeNormalization()
@@ -122,6 +145,8 @@ public function getConfigTreeBuilder()
                         ->arrayNode('locales')
                             ->prototype('scalar')->end()
                         ->end()
+                        ->booleanNode('match_implicit_locale')->defaultValue(true)->end()
+                        ->booleanNode('auto_locale_pattern')->defaultValue(false)->end()
                     ->end()
                 ->end()
             ->end()

Doctrine/DoctrineProvider.php

@@ -73,8 +73,9 @@ public function setManagerName($managerName)
     }
 
     /**
-     * Set the limit to apply when calling getRoutesByNames() with null.
-     * Note that setting the limit to null means no limit applied.
+     * Set the limit to apply when calling getAllRoutes().
+     *
+     * Setting the limit to null means no limit is applied.
      *
      * @param integer|null $routeCollectionLimit
      */

Doctrine/Orm/RouteProvider.php

@@ -12,6 +12,9 @@
 
 namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Orm;
 
+use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\Common\Persistence\ObjectRepository;
+use Symfony\Cmf\Component\Routing\Candidates\CandidatesInterface;
 use Symfony\Component\Routing\RouteCollection;
 use Symfony\Component\Routing\Exception\RouteNotFoundException;
 
@@ -32,37 +35,46 @@
 class RouteProvider extends DoctrineProvider implements RouteProviderInterface
 {
     /**
-     * @param $url
-     *
-     * @return array
+     * @var CandidatesInterface
      */
-    protected function getCandidates($url)
+    private $candidatesStrategy;
+
+    public function __construct(ManagerRegistry $managerRegistry, CandidatesInterface $candidatesStrategy, $className)
     {
-        $candidates = array();
-        if ('/' !== $url) {
-            if (preg_match('/(.+)\.[a-z]+$/i', $url, $matches)) {
-                $candidates[] = $url;
-                $url = $matches[1];
-            }
+        parent::__construct($managerRegistry, $className);
+        $this->candidatesStrategy = $candidatesStrategy;
+    }
 
-            $part = $url;
-            while (false !== ($pos = strrpos($part, '/'))) {
-                $candidates[] = $part;
-                $part = substr($url, 0, $pos);
-            }
-        }
+    /**
+     * {@inheritDoc}
+     */
+    public function getRouteCollectionForRequest(Request $request)
+    {
+        $collection = new RouteCollection();
 
-        $candidates[] = '/';
+        $candidates = $this->candidatesStrategy->getCandidates($request);
+        if (empty($candidates)) {
+            return $collection;
+        }
+        $routes = $this->getRouteRepository()->findByStaticPrefix($candidates, array('position' => 'ASC'));
+        /** @var $route Route */
+        foreach ($routes as $route) {
+            $collection->add($route->getName(), $route);
+        }
 
-        return $candidates;
+        return $collection;
     }
 
     /**
      * {@inheritDoc}
      */
     public function getRouteByName($name)
     {
-        $route = $this->getRoutesRepository()->findOneBy(array('name' => $name));
+        if (!$this->candidatesStrategy->isCandidate($name)) {
+            throw new RouteNotFoundException(sprintf('Route "%s" is not handled by this route provider', $name));
+        }
+
+        $route = $this->getRouteRepository()->findOneBy(array('name' => $name));
         if (!$route) {
             throw new RouteNotFoundException("No route found for name '$name'");
         }
@@ -76,21 +88,18 @@ public function getRouteByName($name)
     public function getRoutesByNames($names = null)
     {
         if (null === $names) {
-            $names = array();
             if (0 === $this->routeCollectionLimit) {
-                return $names;
-            }
-            if (null !== $this->routeCollectionLimit) {
-                return $this->getRoutesRepository()->findBy(array(), null, $this->routeCollectionLimit);
+                return array();
             }
 
-            return $this->getRoutesRepository()->findAll();
+            return $this->getRouteRepository()->findBy(array(), null, $this->routeCollectionLimit);
         }
 
         $routes = array();
         foreach ($names as $name) {
+            // TODO: if we do findByName with multivalue, we need to filter with isCandidate afterwards
             try {
-                $routes[] = $this->getRouteByName($name, $parameters);
+                $routes[] = $this->getRouteByName($name);
             } catch (RouteNotFoundException $e) {
                 // not found
             }
@@ -100,39 +109,9 @@ public function getRoutesByNames($names = null)
     }
 
     /**
-     * {@inheritDoc}
-     */
-    public function getRouteCollectionForRequest(Request $request)
-    {
-        $url = $request->getPathInfo();
-
-        $candidates = $this->getCandidates($url);
-
-        $collection = new RouteCollection();
-
-        if (empty($candidates)) {
-            return $collection;
-        }
-
-        $routes = $this->getRoutesRepository()->findByStaticPrefix($candidates, array('position' => 'ASC'));
-        foreach ($routes as $key => $route) {
-            if (preg_match('/.+\.([a-z]+)$/i', $url, $matches)) {
-                if ($route->getDefault('_format') === $matches[1]) {
-                    continue;
-                }
-
-                $route->setDefault('_format', $matches[1]);
-            }
-            $collection->add($key, $route);
-        }
-
-        return $collection;
-    }
-
-    /**
-     * @return \Doctrine\Common\Persistence\ObjectRepository
+     * @return ObjectRepository
      */
-    protected function getRoutesRepository()
+    protected function getRouteRepository()
     {
         return $this->getObjectManager()->getRepository($this->className);
     }