implement sitemap and error handling of seo-bundle

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

@@ -0,0 +1,42 @@
+{% extends 'base.html.twig' %}
+
+{% block content %}
+    <h1>Oops! An Error Occurred</h1>
+    <h2>The server returned a "{{ status_code }} {{ status_text }}".</h2>
+    <p>If you see this page, it means your sandbox is not correctly set up.
+        Please see the README file in the sandbox root folder and if you can't figure out
+        what is wrong, ask us on freenode irc #symfonycmf or the mailinglist [email protected].
+    </p>
+
+    <p>If you are seeing this page as the result of an edit in the admin tool, please report what you were doing
+        to our <a href="https://github.com/symfony-cmf/cmf-sandbox/issues/new">ticket system</a>,
+        so that we can add means to prevent this issue in the future. But to get things working again
+        for now, please just <a href="{{ app.request.getSchemeAndHttpHost() }}/reloadfixtures.php">click here</a>
+        to reload the data fixtures.
+    </p><p style='color:red;'>
+    <strong>Detected the following problem</strong>:
+    {{ exception.getMessage() }}
+
+    <h3>Suggested pages</h3>
+    <div class="alert  alert-info  clearfix">
+        <p>
+            This page is rendered by the
+            <code>SuggestionProviderController</code>
+            of the CmfSeoBundle. This way, usefull suggestions can be shown to your users.
+        </p>
+
+        <a class="docref" href="http://symfony.com/doc/current/cmf/bundles/seo/error_pages.html">
+            <i class="glyphicon glyphicon-chevron-right"></i>Read about this feature in the CMF documentation.
+        </a>
+    </div>
+    {% for group, list in best_matches if list is not empty %}
+        <h4>{{ group|capitalize }}</h4>
+        <ul>
+            {% for match in list %}
+                <li><a href="{{ path(match.id) }}">{{ match.content.title }}</a></li>
+            {% endfor %}
+        </ul>
+    {% else %}
+        <h4>No suggestions found</h4>
+    {% endfor %}
+{% endblock %}

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

@@ -0,0 +1,20 @@
+{% extends 'base.html.twig' %}
+
+{% block content %}
+    <h1>Sitemap</h1>
+    <p>
+        The sitemap feature allows to give an overview of the content.
+        The content document decides whether it should be displayed on a sitemap or not.
+        The sitemap of the symfony-cmf sandbox is relatively flat because the content URL structure is flat.
+        If you have deeper nested content, the sitemap is organized along the nested structure.<br />
+        This information is arranged for human users. For search engines, the sitemap also exists in
+        an <a href="{{ url('cmf_seo_sitemap', {_format: 'xml', sitemap: 'sitemap'}) }}">xml format</a>.
+    </p>
+    <ul class="cmf-sitemap">
+        {% for url in urls %}
+            <li{% if url.depth is not null %} class="indent-{{ url.depth }}"{% endif %}>
+                <a href="{{ url.location }}" title="{{ url.label }}">{{ url.label }}</a>
+            </li>
+        {% endfor %}
+    </ul>
+{% endblock %}

app/Resources/views/sitemap/index.xml.twig

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+    {% for url in urls %}
+        <url>
+            <loc>{{ url.location }}</loc>
+            {% if url.lastModification %}
+            <lastmod>{{ url.lastModification }}</lastmod>
+            {% endif %}
+            <changefreq>{{ url.changeFrequency }}</changefreq>
+            {% if url.alternateLocales is defined and url.alternateLocales|length > 0 %}
+                {% for locale in url.alternateLocales %}
+                <xhtml:link rel="alternate" hreflang="{{ locale.hrefLocale }}" href="{{ locale.href }}"/>
+                {% endfor %}
+            {% endif %}
+        </url>
+    {% endfor %}
+</urlset>

app/config/config.yml

@@ -22,7 +22,7 @@ framework:
 twig:
     debug:            '%kernel.debug%'
     strict_variables: '%kernel.debug%'
-    exception_controller: 'FOS\RestBundle\Controller\ExceptionController::showAction'
+    exception_controller: cmf_seo.error.suggestion_provider.controller:listAction
 
 # Assetic Configuration
 assetic:
@@ -113,6 +113,23 @@ cmf_seo:
     title: 'CMF Sandbox - %%content_title%%'
     description: 'The Content Management Framework. %%content_description%%'
     alternate_locale: ~
+    error:
+         enable_parent_provider: true
+         enable_sibling_provider: true
+         templates:
+             html: ":error/index.html.twig"
+         exclusion_rules:
+             - { path: 'excluded' }
+    sitemap:
+         defaults:
+             default_change_frequency: never
+             templates:
+                 xml: ':sitemap/index.xml.twig'
+                 html: ':sitemap/index.html.twig'
+         configurations:
+             sitemap: ~
+             frequent:
+                 default_change_frequency: always
 
 cmf_menu:
     voters:

app/config/routing.yml

@@ -52,3 +52,7 @@ block_cache:
 cmf_resource:
     resource: '@CmfResourceRestBundle/Resources/config/routing.yml'
     prefix: /admin
+
+sitemaps:
+     prefix: /sitemaps
+     resource: "@CmfSeoBundle/Resources/config/routing/sitemap.xml"

app/config/services.yml

@@ -3,13 +3,6 @@ services:
         class: AppBundle\Controller\ContentController
         parent: cmf_content.controller
 
-    app.exception_listener:
-        class: AppBundle\EventListener\SandboxExceptionListener
-        calls:
-            - [setContainer, ['@service_container']]
-        tags:
-            - { name: kernel.event_subscriber }
-
     app.twig.menu_extension:
         class: AppBundle\Twig\MenuExtension
         arguments: ['@knp_menu.helper', '@knp_menu.matcher']

src/AppBundle/DataFixtures/PHPCR/LoadMenuData.php

@@ -85,6 +85,8 @@ public function load(ObjectManager $manager)
         $this->createMenuNode($manager, $seo, 'simple-seo-example', array('en' => 'Seo-Simple-Content'), $manager->find(null, "$content_path/simple-seo-example"));
         $this->createMenuNode($manager, $seo, 'demo-seo-extractor', array('en' => 'Seo-Extractor'), $manager->find(null, "$content_path/demo-seo-extractor"));
         $this->createMenuNode($manager, $seo, 'simple-seo-property', array('en' => 'Seo-Extra-Properties'), $manager->find(null, "$content_path/simple-seo-property"));
+        $this->createMenuNode($manager, $seo, 'seo-error-pages', array('en' => 'Seo-Error-Pages'), $manager->find(null, "$content_path/seo-error-pages"));
+        $this->createMenuNode($manager, $seo, 'seo-sitemap', 'Sitemap', null, '/sitemaps/sitemap.html');
 
         $this->createMenuNode($manager, $main, 'routing-auto-item', array('en' => 'Auto routing example', 'de' => 'Auto routing beispiel', 'fr' => 'Auto routing exemple'), $manager->find(null, "$content_path/news/RoutingAutoBundle generates routes!"));
 

src/AppBundle/DataFixtures/PHPCR/LoadNewsData.php

@@ -51,6 +51,7 @@ public function load(ObjectManager $manager)
 See the routing auto <a href="https://github.com/symfony-cmf/cmf-sandbox/blob/master/src/AppBundle/Resources/config/cmf_routing_auto.yml">configuration file</a> to see how this works.
 EOT
     );
+        $news->setIsVisibleForSitemap(true);
 
         $manager->persist($news);
         $manager->flush();

src/AppBundle/DataFixtures/PHPCR/LoadRoutingData.php

@@ -115,6 +115,11 @@ public function load(ObjectManager $manager)
             $seo->setPosition($home, 'demo-seo-extractor');
             $seo->setContent($manager->find(null, "$content_path/demo-seo-extractor"));
             $manager->persist($seo);
+
+            $seo = new Route();
+            $seo->setPosition($home, 'seo-error-pages');
+            $seo->setContent($manager->find(null, "$content_path/seo-error-pages"));
+            $manager->persist($seo);
         }
 
         // demo features of routing

src/AppBundle/DataFixtures/PHPCR/LoadStaticPageData.php

@@ -18,6 +18,7 @@
 use PHPCR\Util\NodeHelper;
 use AppBundle\Document\DemoSeoContent;
 use Symfony\Cmf\Bundle\SeoBundle\Doctrine\Phpcr\SeoMetadata;
+use Symfony\Cmf\Bundle\SeoBundle\SitemapAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\Yaml\Parser;
@@ -95,6 +96,10 @@ public function load(ObjectManager $manager)
                     $this->loadBlock($manager, $page, $name, $block);
                 }
             }
+
+            if ($page instanceof SitemapAwareInterface) {
+                $page->setIsVisibleForSitemap(true);
+            }
         }
 
         //add a loading for a simple seo aware page
@@ -114,6 +119,7 @@ public function load(ObjectManager $manager)
 EOH
         );
         $seoDemo->setParentDocument($parent);
+        $seoDemo->setIsVisibleForSitemap(true);
 
         $seoMetadata = new SeoMetadata();
         $seoMetadata->setTitle('Simple seo example');
@@ -146,6 +152,7 @@ public function load(ObjectManager $manager)
         $seoMetadata->addExtraName('robots', 'index, follow');
         $seoMetadata->addExtraProperty('og:title', 'extra title');
         $seoDemo->setSeoMetadata($seoMetadata);
+        $seoDemo->setIsVisibleForSitemap(true);
         $manager->persist($seoDemo);
 
         $manager->bindTranslation($seoDemo, 'en');

src/AppBundle/Document/DemoClassContent.php

@@ -12,6 +12,7 @@
 namespace AppBundle\Document;
 
 use Doctrine\ODM\PHPCR\Mapping\Annotations as PHPCRODM;
+use Symfony\Cmf\Bundle\SeoBundle\SitemapAwareInterface;
 use Symfony\Component\Validator\Constraints as Assert;
 use Symfony\Cmf\Component\Routing\RouteReferrersReadInterface;
 
@@ -20,7 +21,7 @@
  *
  * @PHPCRODM\Document(referenceable=true)
  */
-class DemoClassContent implements RouteReferrersReadInterface
+class DemoClassContent implements RouteReferrersReadInterface, SitemapAwareInterface
 {
     /**
      * to create the document at the specified location. read only for existing documents.
@@ -62,6 +63,13 @@ class DemoClassContent implements RouteReferrersReadInterface
      */
     public $routes;
 
+    /**
+     * @var bool
+     *
+     * @PHPCRODM\Field(type="boolean", property="visible_for_sitemap")
+     */
+    private $isVisibleForSitemap;
+
     public function getName()
     {
         return $this->name;
@@ -117,4 +125,25 @@ public function getRoutes()
     {
         return $this->routes->toArray();
     }
+
+    /**
+     * Decision whether a document should be visible
+     * in sitemap or not.
+     *
+     * @param $sitemap
+     *
+     * @return bool
+     */
+    public function isVisibleInSitemap($sitemap)
+    {
+        return $this->isVisibleForSitemap;
+    }
+
+    /**
+     * @param bool $isVisibleForSitemap
+     */
+    public function setIsVisibleForSitemap($isVisibleForSitemap)
+    {
+        $this->isVisibleForSitemap = $isVisibleForSitemap;
+    }
 }

src/AppBundle/Document/DemoSeoContent.php

@@ -15,6 +15,7 @@
 use Symfony\Cmf\Bundle\ContentBundle\Doctrine\Phpcr\StaticContent;
 use Symfony\Cmf\Bundle\SeoBundle\SeoAwareInterface;
 use Symfony\Cmf\Bundle\SeoBundle\Doctrine\Phpcr\SeoMetadata;
+use Symfony\Cmf\Bundle\SeoBundle\SitemapAwareInterface;
 
 /**
  * That example class uses the extractors for the creation of the SeoMetadata.
@@ -23,7 +24,7 @@
  *
  * @author Maximilian Berghoff <[email protected]>
  */
-class DemoSeoContent extends StaticContent implements SeoAwareInterface
+class DemoSeoContent extends StaticContent implements SeoAwareInterface, SitemapAwareInterface
 {
     /**
      * @var SeoMetadata
@@ -32,6 +33,13 @@ class DemoSeoContent extends StaticContent implements SeoAwareInterface
      */
     protected $seoMetadata;
 
+    /**
+     * @var bool
+     *
+     * @PHPCRODM\Field(type="boolean", property="visible_for_sitemap")
+     */
+    private $isVisibleForSitemap;
+
     public function __construct()
     {
         $this->seoMetadata = new SeoMetadata();
@@ -53,4 +61,25 @@ public function setSeoMetadata($seoMetadata)
     {
         $this->seoMetadata = $seoMetadata;
     }
+
+    /**
+     * Decision whether a document should be visible
+     * in sitemap or not.
+     *
+     * @param $sitemap
+     *
+     * @return bool
+     */
+    public function isVisibleInSitemap($sitemap)
+    {
+        return $this->isVisibleForSitemap;
+    }
+
+    /**
+     * @param bool $isVisibleForSitemap
+     */
+    public function setIsVisibleForSitemap($isVisibleForSitemap)
+    {
+        $this->isVisibleForSitemap = $isVisibleForSitemap;
+    }
 }

src/AppBundle/Document/DemoSeoExtractor.php

@@ -24,11 +24,7 @@
  *
  * @author Maximilian Berghoff <[email protected]>
  */
-class DemoSeoExtractor extends DemoSeoContent implements
-    TitleReadInterface,
-    DescriptionReadInterface,
-    OriginalUrlReadInterface,
-    KeywordsReadInterface
+class DemoSeoExtractor extends DemoSeoContent implements TitleReadInterface, DescriptionReadInterface, OriginalUrlReadInterface, KeywordsReadInterface
 {
     /**
      * {@inheritdoc}

src/AppBundle/Resources/data/page.yml

@@ -236,3 +236,38 @@ static:
                 können einfach ausgelesen werden.
 
                 <a class="docref" href="http://symfony.com/doc/current/cmf/bundles/seo/extractors.html"><i class="glyphicon glyphicon-chevron-right"></i>Read about this feature in the CMF documentation (translation needed).</a>
+    -
+      name: seo-error-pages
+      title:
+          en: SEO error pages
+          de: SEO optimierte Fehlerseiten
+      body:
+          en: |
+              Error pages with stack traces are good for development, but very bad end user experience and
+              a security risk. The default Symfony error handling produces a decent but very unhelpful
+              error page.
+              <br />
+              With the CMF, we have the possibility to do better, particulary on not found pages.
+              The CmfSeoBundle defines the SuggestionProvider. Implementations provide possible alternatives
+              when content is not found. This could be pages with a parent path of the requested path
+              or other custom logic.
+              <br />
+              To see this in action, try to open the following pages:
+              <ul>
+                <li><a href="/demo/controlle">Error!!</a></li>
+                <li><a href="/en/company/mor">Error!!</a></li>
+              </ul>
+          de: |
+              Fehlerseiten mit Stack Traces von Exceptions sind gut zum entwickeln, aber schlecht für
+              die Benutzer der Seite und ein Sicherheitsproblem. Das Symfony Fehlerhandling produziert
+              vernünftige Fehlerseiten, die aber dem Benutzer nicht wirklich weiter helfen.<br />
+              Mit dem CMF haben wir bessere Möglichkeiten, insbesondere wenn etwas nicht gefunden wird.
+              Das CmfSeoBundle definiert SuggestionProvider. Implementationen dieses providers liefern
+              mögliche Alternativen wenn ein Inhalt nicht gefunden wird. Zum Beispiel Nachbarn oder Eltern
+              der gewünschten URL. <br />
+              Probiere es einfach aus, nimm Buchstaben aus der aktuellen URL oder klicke einen dieser Links:
+              <ul>
+                <li><a href="/demo/controller">Error!!</a></li>
+                <li><a href="/de/company/mor">Error!!</a></li>
+              </ul>
+

tests/Functional/HomepageTest.php

@@ -38,7 +38,7 @@ public function testContents()
         $this->assertCount(1, $crawler->filter('h1:contains(Homepage)'));
         $this->assertCount(1, $crawler->filter('h2:contains("Welcome to the Symfony CMF Demo")'));
 
-        $this->assertCount(23, $crawler->filter('.panel-nav li'));
+        $this->assertCount(25, $crawler->filter('.panel-nav li'));
     }
 
     public function testJsonContents()

tests/Functional/StaticPageTest.php

@@ -47,6 +47,7 @@ public function contentDataProvider()
             array('/demo/class', 'Controller by class'),
             array('/hello', 'Hello World!'),
             array('/en/about', 'Some information about us'),
+            'sitemap' => array('/sitemaps/sitemap.html', 'Sitemap'),
         );
     }
 
@@ -65,4 +66,14 @@ public function testJson()
         );
         $this->assertContains('"title":"The Team",', $response->getContent());
     }
+
+    public function testErrorPage()
+    {
+        $client = $this->createClient();
+        $client->request('GET', '/en/company/tea');
+        $this->assertStatusCode(404, $client);
+
+        $response = $client->getResponse();
+        $this->assertContains('Oops! An Error Occurred', $response->getContent());
+    }
 }

web/app.php

@@ -21,7 +21,6 @@
 $kernel->loadClassCache();
 //$kernel = new AppCache($kernel);
 
-
 // When using the HttpCache, you need to call the method in your front
 // controller instead of relying on the configuration parameter
 //Request::enableHttpMethodParameterOverride();

web/assets/css/style.css

@@ -26,6 +26,21 @@ body { padding-top:50px; }
 }
     .navbar-dropdown .dropdown-menu { margin-top:-5px; }
 
+.cmf-sitemap .indent-1 {
+    margin-left: 20px;
+}
+
+.cmf-sitemap .indent-2 {
+    margin-left: 40px;
+}
+
+.cmf-sitemap .indent-3 {
+    margin-left: 60px;
+}
+
+.cmf-sitemap .indent-4 {
+    margin-left: 80px;
+}