[RTM] Support for replaying headers

composer.json

@@ -42,6 +42,8 @@
         "simplepie/simplepie": "^1.3",
         "tecnickcom/tcpdf": "^6.0",
         "true/punycode": "^2.0",
+        "terminal42/header-replay-bundle": "^1.0",
+        "php-http/guzzle6-adapter": "^1.1",
         "twig/twig": "^1.26",
         "webmozart/path-util": "^2.0",
         "contao/image": "^0.3.1",

src/ContaoManager/Plugin.php

@@ -29,6 +29,7 @@
 use Symfony\Bundle\TwigBundle\TwigBundle;
 use Symfony\Component\Config\Loader\LoaderResolverInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
+use Terminal42\HeaderReplay\HeaderReplayBundle;
 
 /**
  * Plugin for the Contao Manager.
@@ -43,7 +44,7 @@ class Plugin implements BundlePluginInterface, RoutingPluginInterface
     public function getBundles(ParserInterface $parser)
     {
         return [
-            BundleConfig::create(KnpMenuBundle::class),
+            BundleConfig::create(HeaderReplayBundle::class),
             BundleConfig::create(KnpTimeBundle::class),
             BundleConfig::create(ContaoCoreBundle::class)
                 ->setReplace(['core'])

src/EventListener/HeaderReplay/BackendSessionListener.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of Contao.
+ *
+ * Copyright (c) 2005-2017 Leo Feyer
+ *
+ * @license LGPL-3.0+
+ */
+
+namespace Contao\CoreBundle\EventListener\HeaderReplay;
+
+use Symfony\Component\HttpFoundation\Request;
+use Terminal42\HeaderReplay\Event\HeaderReplayEvent;
+use Terminal42\HeaderReplay\EventListener\HeaderReplayListener;
+
+/**
+ * Disables the reverse proxy based on the terminal42/header-replay-bundle.
+ *
+ * @author Yanick Witschi <https://github.com/toflar>
+ */
+class BackendSessionListener
+{
+    /**
+     * @var bool
+     */
+    private $disableIpCheck;
+
+    /**
+     * BackendSessionListener constructor.
+     *
+     * @param bool $disableIpCheck
+     */
+    public function __construct($disableIpCheck)
+    {
+        $this->disableIpCheck = $disableIpCheck;
+    }
+
+    /**
+     * @param HeaderReplayEvent $event
+     */
+    public function onReplay(HeaderReplayEvent $event)
+    {
+        $request = $event->getRequest();
+
+        if (null === $request->getSession() || !$this->hasAuthenticatedBackendUser($request)) {
+            return;
+        }
+
+        $headers = $event->getHeaders();
+        $headers->set(HeaderReplayListener::FORCE_NO_CACHE_HEADER_NAME, 'true');
+    }
+
+    /**
+     * Checks if there is an authenticated back end user.
+     *
+     * @param Request $request
+     *
+     * @return bool
+     */
+    private function hasAuthenticatedBackendUser(Request $request)
+    {
+        if (!$request->cookies->has('BE_USER_AUTH')) {
+            return false;
+        }
+
+        $sessionHash = sha1(
+            sprintf(
+                '%s%sBE_USER_AUTH',
+                $request->getSession()->getId(),
+                $this->disableIpCheck ? '' : $request->getClientIp()
+            )
+        );
+
+        return $request->cookies->get('BE_USER_AUTH') === $sessionHash;
+    }
+}

src/EventListener/HeaderReplay/PageLayoutListener.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of Contao.
+ *
+ * Copyright (c) 2005-2017 Leo Feyer
+ *
+ * @license LGPL-3.0+
+ */
+
+namespace Contao\CoreBundle\EventListener\HeaderReplay;
+
+use Contao\CoreBundle\Framework\ContaoFrameworkInterface;
+use Contao\Environment;
+use Terminal42\HeaderReplay\Event\HeaderReplayEvent;
+
+/**
+ * Extracts the page layout for proper Vary handling based
+ * on the terminal42/header-replay-bundle.
+ *
+ * @author Yanick Witschi <https://github.com/toflar>
+ */
+class PageLayoutListener
+{
+    /**
+     * @var ContaoFrameworkInterface
+     */
+    private $framework;
+
+    /**
+     * PageLayoutListener constructor.
+     *
+     * @param ContaoFrameworkInterface $framework
+     */
+    public function __construct(ContaoFrameworkInterface $framework)
+    {
+        $this->framework = $framework;
+    }
+
+    /**
+     * @param HeaderReplayEvent $event
+     */
+    public function onReplay(HeaderReplayEvent $event)
+    {
+        $request = $event->getRequest();
+
+        $this->framework->initialize();
+
+        $mobile = $this->framework->getAdapter(Environment::class)->get('agent')->mobile;
+
+        if ($request->cookies->has('TL_VIEW')) {
+            switch ($request->cookies->get('TL_VIEW')) {
+                case 'mobile':
+                    $mobile = true;
+                    break;
+                case 'desktop':
+                    $mobile = false;
+            }
+        }
+
+        $headers = $event->getHeaders();
+        $headers->set('Contao-Page-Layout', $mobile ? 'mobile' : 'desktop');
+    }
+}

src/Resources/config/listener.yml

@@ -69,6 +69,20 @@ services:
         tags:
             - { name: kernel.event_listener, event: kernel.exception, method: onKernelException, priority: 96 }
 
+    contao.listener.header_replay.backend_session:
+        class: Contao\CoreBundle\EventListener\HeaderReplay\BackendSessionListener
+        arguments:
+            - "%contao.security.disable_ip_check%"
+        tags:
+            - { name: kernel.event_listener, event: t42.header_replay, method: onReplay }
+
+    contao.listener.header_replay.page_layout:
+        class: Contao\CoreBundle\EventListener\HeaderReplay\PageLayoutListener
+        arguments:
+            - "@contao.framework"
+        tags:
+            - { name: kernel.event_listener, event: t42.header_replay, method: onReplay }
+
     contao.listener.insecure_installation:
         class: Contao\CoreBundle\EventListener\InsecureInstallationListener
         tags:

src/Resources/contao/classes/FrontendTemplate.php

@@ -371,9 +371,13 @@ private function setCacheHeaders(Response $response)
 			return $response->setPrivate();
 		}
 
-		// Do not cache the response if a user is logged in or the page is protected or uses a mobile layout
-		// TODO: Add support for proxies so they can vary on member context and page layout
-		if (FE_USER_LOGGED_IN === true || BE_USER_LOGGED_IN === true || $objPage->isMobile || $objPage->protected || $this->hasAuthenticatedBackendUser())
+		// Vary on page layout
+		$response->setVary(['Contao-Page-Layout'], false);
+		$response->headers->set('Contao-Page-Layout', $objPage->isMobile ? 'mobile' : 'desktop');
+
+		// Do not cache the response if a user is logged in or the page is protected
+		// TODO: Add support for proxies so they can vary on member context
+		if (FE_USER_LOGGED_IN === true || BE_USER_LOGGED_IN === true || $objPage->protected || $this->hasAuthenticatedBackendUser())
 		{
 			return $response->setPrivate();
 		}

tests/EventListener/HeaderReplay/BackendSessionListenerTest.php

@@ -0,0 +1,103 @@
+<?php
+
+/*
+ * This file is part of Contao.
+ *
+ * Copyright (c) 2005-2017 Leo Feyer
+ *
+ * @license LGPL-3.0+
+ */
+
+namespace Contao\CoreBundle\Tests\EventListener\HeaderReplay;
+
+use Contao\CoreBundle\EventListener\HeaderReplay\BackendSessionListener;
+use Contao\CoreBundle\Tests\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\ResponseHeaderBag;
+use Symfony\Component\HttpFoundation\Session\Session;
+use Terminal42\HeaderReplay\Event\HeaderReplayEvent;
+use Terminal42\HeaderReplay\EventListener\HeaderReplayListener;
+
+/**
+ * Tests the BackendSessionListener class.
+ *
+ * @author Yanick Witschi <https://github.com/toflar>
+ */
+class BackendSessionListenerTest extends TestCase
+{
+    /**
+     * Tests the object instantiation.
+     */
+    public function testInstantiation()
+    {
+        $listener = new BackendSessionListener(false);
+
+        $this->assertInstanceOf('Contao\CoreBundle\EventListener\HeaderReplay\BackendSessionListener', $listener);
+    }
+
+    public function testOnReplayWithNoSession()
+    {
+        $listener = new BackendSessionListener(false);
+
+        $request = new Request();
+        $headers = new ResponseHeaderBag();
+        $event = new HeaderReplayEvent($request, $headers);
+
+        $listener->onReplay($event);
+
+        $this->assertArrayNotHasKey(HeaderReplayListener::FORCE_NO_CACHE_HEADER_NAME, $event->getHeaders()->all());
+    }
+
+    public function testOnReplayWithNoAuthCookie()
+    {
+        $listener = new BackendSessionListener(false);
+
+        $session = new Session();
+        $request = new Request();
+        $request->setSession($session);
+        $headers = new ResponseHeaderBag();
+        $event = new HeaderReplayEvent($request, $headers);
+
+        $listener->onReplay($event);
+
+        $this->assertNotNull($request->getSession());
+        $this->assertArrayNotHasKey(HeaderReplayListener::FORCE_NO_CACHE_HEADER_NAME, $event->getHeaders()->all());
+    }
+
+    public function testOnReplayWithNoValidCookie()
+    {
+        $listener = new BackendSessionListener(false);
+
+        $session = new Session();
+        $request = new Request();
+        $request->cookies->set('BE_USER_AUTH', 'foobar');
+        $request->setSession($session);
+        $headers = new ResponseHeaderBag();
+        $event = new HeaderReplayEvent($request, $headers);
+
+        $listener->onReplay($event);
+
+        $this->assertNotNull($request->getSession());
+        $this->assertTrue($request->cookies->has('BE_USER_AUTH'));
+        $this->assertArrayNotHasKey(HeaderReplayListener::FORCE_NO_CACHE_HEADER_NAME, $event->getHeaders()->all());
+    }
+
+    public function testOnReplay()
+    {
+        $listener = new BackendSessionListener(false);
+
+        $session = new Session();
+        $session->setId('foobar-id');
+        $request = new Request();
+        $request->cookies->set('BE_USER_AUTH', 'f6d5c422c903288859fb5ccf03c8af8b0fb4b70a');
+        $request->setSession($session);
+        $headers = new ResponseHeaderBag();
+        $event = new HeaderReplayEvent($request, $headers);
+
+        $listener->onReplay($event);
+
+        $this->assertNotNull($request->getSession());
+        $this->assertTrue($request->cookies->has('BE_USER_AUTH'));
+        $this->assertArrayNotHasKey(HeaderReplayListener::FORCE_NO_CACHE_HEADER_NAME, $event->getHeaders()->all());
+    }
+}