load purge and refresh handlers by default

Author: dbu

Resources/doc/features/invalidation.rst

@@ -4,7 +4,8 @@ Invalidation
 **Works with**:
 
 * :ref:`Varnish <foshttpcache:varnish configuration>`
-* :ref:`Nginx <foshttpcache:nginx configuration>`
+* :ref:`Nginx <foshttpcache:nginx configuration>` (except regular expressions)
+* :doc:`symfony-http-cache` (except regular expressions)
 
 **Preparation**:
 

Resources/doc/features/symfony-http-cache.rst

@@ -15,6 +15,8 @@ concept is to use event subscribers on the HttpCache class.
 
     Symfony HttpCache support is currently limited to following features:
 
+    * Purge
+    * Refresh
     * User context
 
 Extending the correct HttpCache

Resources/doc/features/tagging.rst

@@ -1,7 +1,9 @@
 Tagging
 =======
 
-**Works with**: :ref:`Varnish <foshttpcache:varnish_tagging>`
+**Works with**:
+
+* :ref:`Varnish <foshttpcache:varnish_tagging>`
 
 If your application has many intricate relationships between cached items,
 which makes it complex to invalidate them by route, cache tagging will be

Resources/doc/features/user-context.rst

@@ -3,8 +3,8 @@ User Context
 
 **Works with**:
 
-- :ref:`Varnish <foshttpcache:varnish user context>`
-- :doc:`symfony-http-cache`
+* :ref:`Varnish <foshttpcache:varnish user context>`
+* :doc:`symfony-http-cache`
 
 If your application serves different content depending on the user's group
 or context (guest, editor, admin), you can cache that content per user context.

SymfonyCache/EventDispatchingHttpCache.php

@@ -13,6 +13,8 @@
 
 use FOS\HttpCache\SymfonyCache\CacheEvent;
 use FOS\HttpCache\SymfonyCache\Events;
+use FOS\HttpCache\SymfonyCache\PurgeSubscriber;
+use FOS\HttpCache\SymfonyCache\RefreshSubscriber;
 use FOS\HttpCache\SymfonyCache\UserContextSubscriber;
 use Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache;
 use Symfony\Component\EventDispatcher\EventDispatcher;
@@ -37,7 +39,12 @@
  *   - `self::SUBSCRIBER_NONE` (**no** native subscriber).
  *   - `self::SUBSCRIBER_ALL | ~self::SUBSCRIBER_USER_CONTEXT` (**all** native ones **except** the user context one).
  *
+ * Note: This class looks very similar to the FOSHttpCache library event
+ * dispatching kernel, but extends the FrameworkBundle HttpCache instead of the
+ * one from the HttpKernel component.
+ *
  * @author Jérôme Vieilledent <lolautruche@gmail.com> (courtesy of eZ Systems AS)
+ * @author David Buchmann <mail@davidbu.ch>
  *
  * {@inheritdoc}
  */
@@ -64,6 +71,20 @@ abstract class EventDispatchingHttpCache extends HttpCache
      */
     const SUBSCRIBER_USER_CONTEXT = 1;
 
+    /**
+     * Option for the "fos_default_subscribers" that enables the purge subscriber.
+     *
+     * See class phpdoc for examples.
+     */
+    const SUBSCRIBER_PURGE = 2;
+
+    /**
+     * Option for the "fos_default_subscribers" that enables the refresh subscriber.
+     *
+     * See class phpdoc for examples.
+     */
+    const SUBSCRIBER_REFRESH = 4;
+
     /**
      * @var EventDispatcherInterface
      */
@@ -102,7 +123,8 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
     }
 
     /**
-     * Add subscriber
+     * Add a cache kernel event subscriber that listens to events listed in
+     * FOS\HttpCache\SymfonyCache\Event
      *
      * @param EventSubscriberInterface $subscriber
      */
@@ -111,6 +133,34 @@ public function addSubscriber(EventSubscriberInterface $subscriber)
         $this->getEventDispatcher()->addSubscriber($subscriber);
     }
 
+    /**
+     * Made public to allow event subscribers to do refresh operations.
+     *
+     * {@inheritDoc}
+     */
+    public function fetch(Request $request, $catch = false)
+    {
+        return parent::fetch($request, $catch);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * Adding the Events::PRE_INVALIDATE event.
+     */
+    protected function invalidate(Request $request, $catch = false)
+    {
+        if ($this->getEventDispatcher()->hasListeners(Events::PRE_INVALIDATE)) {
+            $event = new CacheEvent($this, $request);
+            $this->getEventDispatcher()->dispatch(Events::PRE_INVALIDATE, $event);
+            if ($event->getResponse()) {
+                return $event->getResponse();
+            }
+        }
+
+        return parent::invalidate($request, $catch);
+    }
+
     /**
      * Return the subscribers to be added to the event dispatcher, according to the
      * fos_default_subscribers option in `getOptions()`.
@@ -127,6 +177,12 @@ protected function getDefaultSubscribers()
         if ($defaultSubscribersOption & self::SUBSCRIBER_USER_CONTEXT) {
             $subscribers[] = new UserContextSubscriber();
         }
+        if ($defaultSubscribersOption & self::SUBSCRIBER_PURGE) {
+            $subscribers[] = new PurgeSubscriber();
+        }
+        if ($defaultSubscribersOption & self::SUBSCRIBER_REFRESH) {
+            $subscribers[] = new RefreshSubscriber();
+        }
 
         return $subscribers;
     }

Tests/Unit/SymfonyCache/EventDispatchingHttpCacheTest.php

@@ -11,6 +11,8 @@
 
 namespace FOS\HttpCacheBundle\Tests\Unit\SymfonyCache;
 
+use FOS\HttpCache\SymfonyCache\PurgeSubscriber;
+use FOS\HttpCache\SymfonyCache\RefreshSubscriber;
 use FOS\HttpCacheBundle\SymfonyCache\EventDispatchingHttpCache;
 use FOS\HttpCache\SymfonyCache\CacheEvent;
 use FOS\HttpCache\SymfonyCache\Events;
@@ -119,13 +121,14 @@ public function testConfiguredSubscribers(array $options, array $expectedSubscri
 
     public function configuredSubscribersProvider()
     {
+        $all = array(new UserContextSubscriber(), new PurgeSubscriber(), new RefreshSubscriber());
         return array(
-            array(array(), array(new UserContextSubscriber())),
+            array(array(), $all),
             array(
                 array(
                     'fos_default_subscribers' => EventDispatchingHttpCache::SUBSCRIBER_ALL,
                 ),
-                array(new UserContextSubscriber())
+                $all
             ),
             array(
                 array(