Adding support for user context for symfony HttpCache of the symfony/http-kernel component

Author: dbu

CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+1.2.0
+-----
+
+* **2014-12-05** Added support for the symfony/http-kernel component reverse proxy HttpCache.
+
 1.1.2
 -----
 

composer.json

@@ -29,7 +29,8 @@
         "guzzle/plugin-mock": "*",
         "mockery/mockery": "*",
         "monolog/monolog": "*",
-        "symfony/process": "~2.3"
+        "symfony/process": "~2.3",
+        "symfony/http-kernel": "~2.3"
     },
     "suggest": {
         "monolog/monolog": "For logging issues while invalidating"
@@ -42,7 +43,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.1.x-dev"
+            "dev-master": "1.2.x-dev"
         }
     }
 }

src/SymfonyCache/CacheEvent.php

@@ -0,0 +1,92 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\SymfonyCache;
+
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\HttpCache\HttpCache as BaseHttpCache;
+
+/**
+ * Event raised by the HttpCache kernel.
+ *
+ * @author David Buchmann <[email protected]>
+ */
+class CacheEvent extends Event
+{
+    /**
+     * @var BaseHttpCache
+     */
+    private $kernel;
+
+    /**
+     * @var Request
+     */
+    private $request;
+
+    /**
+     * @var Response
+     */
+    private $response;
+
+    /**
+     * @param BaseHttpCache $kernel  The kernel raising with this event.
+     * @param Request       $request The request being processed.
+     */
+    public function __construct(BaseHttpCache $kernel, Request $request)
+    {
+        $this->kernel = $kernel;
+        $this->request = $request;
+    }
+
+    /**
+     * Get the cache kernel that raised this event.
+     *
+     * @return BaseHttpCache
+     */
+    public function getKernel()
+    {
+        return $this->kernel;
+    }
+
+    /**
+     * Get the request that is being processed.
+     *
+     * @return Request
+     */
+    public function getRequest()
+    {
+        return $this->request;
+    }
+
+    /**
+     * @return Response|null The response if one was set.
+     */
+    public function getResponse()
+    {
+        return $this->response;
+    }
+
+    /**
+     * Sets a response to use instead of continuing to handle this request.
+     *
+     * Setting a response stops propagation of the event to further event handlers.
+     *
+     * @param Response $response
+     */
+    public function setResponse(Response $response)
+    {
+        $this->response = $response;
+
+        $this->stopPropagation();
+    }
+}

src/SymfonyCache/Events.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\SymfonyCache;
+
+/**
+ * Events used in the customized Symfony built-in reverse proxy HttpCache.
+ */
+final class Events
+{
+    const PRE_HANDLE = 'fos_http_cache.pre_handle';
+}

src/SymfonyCache/HttpCache.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\SymfonyCache;
+
+use Symfony\Component\HttpKernel\HttpCache\HttpCache as BaseHttpCache;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+
+/**
+ * Base class for enhanced Symfony reverse proxy based on the symfony component.
+ *
+ * <b>When using FOSHttpCacheBundle, look at FOS\HttpCacheBundle\HttpCache instead.</b>
+ *
+ * This kernel supports event subscribers that can act on the events defined in
+ * FOS\HttpCache\SymfonyCache\Events and may alter the request flow.
+ *
+ * @author Jérôme Vieilledent <[email protected]> (courtesy of eZ Systems AS)
+ *
+ * {@inheritdoc}
+ */
+abstract class HttpCache extends BaseHttpCache
+{
+    /**
+     * @var EventDispatcherInterface
+     */
+    private $eventDispatcher;
+
+    /**
+     * Get event dispatcher
+     *
+     * @return EventDispatcherInterface
+     */
+    public function getEventDispatcher()
+    {
+        if (null === $this->eventDispatcher) {
+            $this->eventDispatcher = new EventDispatcher();
+        }
+
+        return $this->eventDispatcher;
+    }
+
+    /**
+     * Add subscriber
+     *
+     * @param EventSubscriberInterface $subscriber
+     */
+    public function addSubscriber(EventSubscriberInterface $subscriber)
+    {
+        $this->getEventDispatcher()->addSubscriber($subscriber);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * Adding the Events::PRE_HANDLE event.
+     */
+    public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
+    {
+        if ($this->getEventDispatcher()->hasListeners(Events::PRE_HANDLE)) {
+            $event = new CacheEvent($this, $request);
+            $this->getEventDispatcher()->dispatch(Events::PRE_HANDLE, $event);
+            if ($event->getResponse()) {
+                return $event->getResponse();
+            }
+        }
+
+        return parent::handle($request, $type, $catch);
+    }
+}