[WIP] Create custom behavior for RouteNotFoundException

CHANGELOG.md

@@ -1,6 +1,7 @@
 Changelog
 =========
 
+* **2014-02-08**: Custom exception controller for error handling
 * **2014-06-06**: Updated to PSR-4 autoloading
 
 1.0.0

CmfSeoBundle.php

@@ -14,6 +14,7 @@
 use Doctrine\Bundle\PHPCRBundle\DependencyInjection\Compiler\DoctrinePhpcrMappingsPass;
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass;
 
+use Symfony\Cmf\Bundle\SeoBundle\DependencyInjection\Compiler\RegisterBestMatcherPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
@@ -25,6 +26,7 @@ class CmfSeoBundle extends Bundle
     public function build(ContainerBuilder $container)
     {
         $container->addCompilerPass(new RegisterExtractorsPass());
+        $container->addCompilerPass(new RegisterBestMatcherPass());
 
         $this->buildPhpcrCompilerPass($container);
         $this->buildOrmCompilerPass($container);

DependencyInjection/CmfSeoExtension.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Cmf\Bundle\SeoBundle\DependencyInjection;
 
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
@@ -70,6 +71,10 @@ public function load(array $configs, ContainerBuilder $container)
         if (count($sonataBundles) && $config['sonata_admin_extension']['enabled']) {
             $this->loadSonataAdmin($config['sonata_admin_extension'], $loader, $container, $sonataBundles);
         }
+
+        if ($this->isConfigEnabled($container, $config['error_handling'])) {
+            $this->loadErrorHandling($config['error_handling'], $loader, $container);
+        }
     }
 
     /**
@@ -131,4 +136,18 @@ public function getXsdValidationBasePath()
     {
         return __DIR__.'/../Resources/config/schema';
     }
+
+    /**
+     * @param $config
+     * @param XmlFileLoader $loader
+     * @param ContainerBuilder $container
+     */
+    private function loadErrorHandling($config, XmlFileLoader $loader, ContainerBuilder $container)
+    {
+        if ($container->hasParameter($this->getAlias().'.backend_type_phpcr')
+            && $container->getParameter($this->getAlias().'.backend_type_phpcr')
+        ) {
+            $loader->load('matcher_phpcr.xml');
+        }
+    }
 }

DependencyInjection/Compiler/RegisterBestMatcherPass.php

@@ -0,0 +1,49 @@
+<?php
+
+
+namespace Symfony\Cmf\Bundle\SeoBundle\DependencyInjection\Compiler;
+
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Maximilian Berghoff <Maximilian.Berghoff@gmx.de>
+ */
+class RegisterBestMatcherPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritDoc}
+     *
+     * @throws LogicException If a tagged service is not public.
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasDefinition('cmf_seo.error_handling.matcher.presentation')) {
+            return;
+        }
+
+        $presentationDefinition = $container->getDefinition('cmf_seo.error_handling.matcher.presentation');
+        $taggedServices = $container->findTaggedServiceIds('cmf_seo.best_matcher');
+
+        foreach ($taggedServices as $id => $attributes) {
+            $definition = $container->getDefinition($id);
+            if (!$definition->isPublic()) {
+                throw new LogicException(sprintf('Matcher "%s" must be public.', $id));
+            }
+
+            $group = null;
+            foreach ($attributes as $attribute) {
+                if (isset($attribute['group'])) {
+                    $group = $attribute['group'];
+                    break;
+                }
+            }
+            $group = null !== $group ? $group : 'default';
+
+            $presentationDefinition->addMethodCall('addMatcher', array(new Reference($id), $group));
+        }
+    }
+}

DependencyInjection/Configuration.php

@@ -72,6 +72,10 @@ public function getConfigTreeBuilder()
                         ->scalarNode('form_group')->defaultValue('form.group_seo')->end()
                     ->end()
                 ->end()
+                ->arrayNode('error_handling')
+                        ->addDefaultsIfNotSet()
+                        ->canBeEnabled()
+                ->end()
             ->end()
         ;
 

ErrorHandling/AncestorBestMatcher.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\SeoBundle\ErrorHandling;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * This BestMatcher tries to create a route collection of
+ * all ancestors of a given uri.
+ *
+ * @author Maximilian Berghoff <Maximilian.Berghoff@gmx.de>
+ */
+class AncestorBestMatcher extends PhpcrBestMatcher
+{
+
+    /**
+     * {@inheritDoc}
+     */
+    public function create(Request $request)
+    {
+        // TODO: Implement create() method.
+    }
+}

ErrorHandling/BestMatchPresentation.php

@@ -0,0 +1,90 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\SeoBundle\ErrorHandling;
+
+use Symfony\Bundle\TwigBundle\Controller\ExceptionController;
+use Symfony\Cmf\Bundle\SeoBundle\Exception\InvalidArgumentException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\FlattenException;
+use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
+
+/**
+ * This presentation model enriches the the values to render the
+ * error pages by the help of so called BestMatcher.
+ *
+ * @author Maximilian Berghoff <Maximilian.Berghoff@gmx.de>
+ */
+class BestMatchPresentation extends ExceptionController
+{
+    /**
+     * Chain of matcher.
+     *
+     * @var array|BestMatcherInterface[]
+     */
+    protected $matcherChain = array();
+
+    /**
+     * @param Request              $request
+     * @param FlattenException     $exception
+     * @param DebugLoggerInterface $logger
+     * @param string               $_format
+     * @return Response
+     */
+    public function showAction(
+        Request $request,
+        FlattenException $exception,
+        DebugLoggerInterface $logger = null,
+        $_format = 'html'
+    ) {
+        $code = $exception->getStatusCode();
+
+        if (404 !== $code) {
+            return parent::showAction($request, $exception, $logger, $_format);
+        }
+
+        $currentContent = $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
+        $bestMatches = array();
+
+        foreach ($this->matcherChain as $group => $matcher) {
+            $bestMatches[$group] = $matcher->create($request);
+        }
+
+        $template = $this->findTemplate($request, $_format, $code, $this->debug);
+
+        return new Response($this->twig->render(
+            $template,
+            array(
+                'status_code'    => $code,
+                'status_text'    => isset(Response::$statusTexts[$code]) ? Response::$statusTexts[$code] : '',
+                'exception'      => $exception,
+                'logger'         => $logger,
+                'currentContent' => $currentContent,
+                'best_matches'   => $bestMatches,
+            )
+        ));
+    }
+
+    /**
+     * @param BestMatcherInterface      $matcher
+     * @param string                    $group   Unique per Chain.
+     * @throws InvalidArgumentException
+     */
+    public function addMatcher(BestMatcherInterface $matcher, $group)
+    {
+        if (array_key_exists($group, $this->matcherChain)) {
+            throw new InvalidArgumentException(sprintf('You can only add on matcher with group %s.', $group));
+        }
+
+        $this->matcherChain[$group] = $matcher;
+    }
+}

ErrorHandling/BestMatcherInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+
+namespace Symfony\Cmf\Bundle\SeoBundle\ErrorHandling;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * Interface to create a BestMatcher.
+ *
+ * @author Maximilian Berghoff <Maximilian.Berghoff@gmx.de>
+ */
+interface BestMatcherInterface
+{
+    /**
+     * Based on the current request BestMatcher creates collections of
+     * route as suggestions to navigate to.
+     *
+     * @param Request $request
+     * @return RouteCollection
+     */
+    public function create(Request $request);
+}

ErrorHandling/ParentBestMatcher.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\SeoBundle\ErrorHandling;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * This BestMatcher will try to detect a parent route of a given uri.
+ *
+ * @author Maximilian Berghoff <Maximilian.Berghoff@gmx.de>
+ */
+class ParentBestMatcher extends PhpcrBestMatcher
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function create(Request $request)
+    {
+        $routes = new RouteCollection();
+        $uriAsArray = explode('/', $request->getUri());
+        if (count($uriAsArray) <= 1) {
+            return $routes;
+        }
+
+        $uriAsArray = array_shift($uriAsArray);
+        $parentUri = implode('/', $uriAsArray);
+
+    }
+}

ErrorHandling/PhpcrBestMatcher.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\SeoBundle\ErrorHandling;
+
+use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\ODM\PHPCR\DocumentManager;
+
+/**
+ * Abstract BestMatcher for those who needs make use of base
+ * phpcr-odm classes.
+ *
+ * @author Maximilian Berghoff <Maximilian.Berghoff@gmx.de>
+ */
+abstract class PhpcrBestMatcher implements BestMatcherInterface
+{
+    /**
+     * @var ManagerRegistry
+     */
+    protected $managerRegistry;
+
+    /**
+     * @param ManagerRegistry $managerRegistry
+     */
+    public function setManagerRegistry($managerRegistry)
+    {
+        $this->managerRegistry = $managerRegistry;
+    }
+
+    /**
+     * @return ManagerRegistry
+     */
+    public function getManagerRegistry()
+    {
+        return $this->managerRegistry;
+    }
+
+    /**
+     * @param string                $class
+     * @return null|DocumentManager
+     */
+    public function getManagerForClass($class)
+    {
+        return $this->managerRegistry->getManagerForClass($class);
+    }
+}

Resources/config/matcher_phpcr.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="cmf_seo.error_handling.matcher.parent.class">Symfony\Cmf\Bundle\SeoBundle\ErrorHandling\ParentBestMatcher</parameter>
+        <parameter key="cmf_seo.error_handling.matcher.ancestor.class">Symfony\Cmf\Bundle\SeoBundle\ErrorHandling\AncestorBestMatcher</parameter>
+    </parameters>
+
+    <services>
+        <service id="cmf_seo.error_handling.matcher.parent" class="%cmf_seo.error_handling.matcher.parent.class%">
+            <call method="setManagerRegistry">
+                <argument type="service" id="doctrine_phpcr" />
+            </call>
+            <tag name="cmf_seo.best_matcher" group="parent" />
+        </service>
+        <service id="cmf_seo.error_handling.matcher.ancestor" class="%cmf_seo.error_handling.matcher.ancestor.class%">
+            <call method="setManagerRegistry">
+                <argument type="service" id="doctrine_phpcr" />
+            </call>
+            <tag name="cmf_seo.best_matcher" group="ancestor" />
+        </service>
+
+    </services>
+
+</container>