diff --git a/core/core.services.yml b/core/core.services.yml index a8313a6..a833124 100644 --- a/core/core.services.yml +++ b/core/core.services.yml @@ -79,6 +79,19 @@ services: factory_method: get factory_service: cache_factory arguments: [discovery] + page_cache_request_policy: + class: Drupal\Core\PageCache\DefaultRequestPolicy + tags: + - { name: service_collector, tag: page_cache_request_policy_allow, call: allow} + - { name: service_collector, tag: page_cache_request_policy_deny, call: deny} + page_cache_response_policy: + class: Drupal\Core\PageCache\DefaultResponsePolicy + tags: + - { name: service_collector, tag: page_cache_response_policy_deny, call: deny } + page_cache_kill_switch: + class: Drupal\Core\PageCache\ResponsePolicyRule\KillSwitch + tags: + - { name: page_cache_response_policy_deny } config.manager: class: Drupal\Core\Config\ConfigManager arguments: ['@entity.manager', '@config.factory', '@config.typed', '@string_translation', '@config.storage', '@event_dispatcher'] @@ -610,7 +623,7 @@ services: class: Drupal\Core\EventSubscriber\FinishResponseSubscriber tags: - { name: event_subscriber } - arguments: ['@language_manager', '@config.factory'] + arguments: ['@language_manager', '@config.factory', '@page_cache_request_policy', '@page_cache_response_policy'] scope: request redirect_response_subscriber: class: Drupal\Core\EventSubscriber\RedirectResponseSubscriber diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index a9ea984..ef5dd57 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -659,27 +659,29 @@ function drupal_page_get_cache(Request $request) { } /** - * Determines the cacheability of the current page. + * Enable or disable the page cache bootstrap phase. * - * Note: we do not serve cached pages to authenticated users, or to anonymous - * users when $_SESSION is non-empty. $_SESSION may contain status messages - * from a form submission, the contents of a shopping cart, or other user- - * specific content that should not be cached and displayed to other users. + * This is a temporary workaround to make sure that no cached page is delivered + * during a forced cache clear. This will become obsolete as soon as delivery of + * cached pages is removed from the bootstrap. + * See https://www.drupal.org/node/2177461 * - * @param $allow_caching - * Set to FALSE if you want to prevent this page to get cached. + * @see drupal_rebuild() * - * @return - * TRUE if the current page can be cached, FALSE otherwise. + * @param bool $allow_caching + * (optional) Specify whether the page cache bootstrap phase should be + * executed or not during the next call to drupal_bootstrap(). + * + * @return bool + * TRUE if the page cache bootstrap phase is enabled. */ -function drupal_page_is_cacheable($allow_caching = NULL) { +function drupal_bootstrap_page_cache_enable($allow_caching = NULL) { $allow_caching_static = &drupal_static(__FUNCTION__, TRUE); if (isset($allow_caching)) { $allow_caching_static = $allow_caching; } - return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD') - && !drupal_is_cli(); + return $allow_caching_static; } /** @@ -1190,7 +1192,7 @@ function drupal_set_message($message = NULL, $type = 'status', $repeat = FALSE) } // Mark this page as being uncacheable. - drupal_page_is_cacheable(FALSE); + \Drupal::service('page_cache_kill_switch')->trigger(); } // Messages not set when DB connection fails. @@ -1535,10 +1537,17 @@ function _drupal_bootstrap_page_cache() { $cache_enabled = $config->get('cache.page.use_internal'); } + // This is a temporary workaround to make sure that no cached page is + // delivered during a forced cache clear. This will become obsolete as soon as + // delivery of cached pages is removed from the bootstrap. + // See https://www.drupal.org/node/2177461 + if (!drupal_bootstrap_page_cache_enable()) { + $cache_enabled = FALSE; + } + $request = \Drupal::request(); - // If there is no session cookie and cache is enabled (or forced), try - // to serve a cached page. - if (!$request->cookies->has(session_name()) && $cache_enabled && drupal_page_is_cacheable()) { + $request_policy = \Drupal::service('page_cache_request_policy'); + if ($cache_enabled && $request_policy->apply($request)) { // Get the page from the cache. $response = drupal_page_get_cache($request); // If there is a cached page, display it. diff --git a/core/includes/utility.inc b/core/includes/utility.inc index 6603166..6dbc490 100644 --- a/core/includes/utility.inc +++ b/core/includes/utility.inc @@ -46,8 +46,8 @@ function drupal_rebuild() { PhpStorageFactory::get('service_container')->deleteAll(); PhpStorageFactory::get('twig')->deleteAll(); - // Disable the page cache. - drupal_page_is_cacheable(FALSE); + // Disable delivery of cached pages. + drupal_bootstrap_page_cache_enable(FALSE); // Bootstrap up to where caches exist and clear them. drupal_bootstrap(DRUPAL_BOOTSTRAP_PAGE_CACHE); @@ -55,6 +55,9 @@ function drupal_rebuild() { $bin->deleteAll(); } + // Disable recording of cached pages. + \Drupal::service('page_cache_kill_switch')->trigger(); + drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL); drupal_flush_all_caches(); diff --git a/core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php index 605d979..d04e59f 100644 --- a/core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php +++ b/core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php @@ -10,6 +10,8 @@ use Drupal\Core\Config\Config; use Drupal\Core\Config\ConfigFactoryInterface; use Drupal\Core\Language\LanguageManager; +use Drupal\Core\PageCache\RequestPolicyRuleInterface; +use Drupal\Core\PageCache\ResponsePolicyRuleInterface; use Drupal\Core\Site\Settings; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; @@ -38,16 +40,36 @@ class FinishResponseSubscriber implements EventSubscriberInterface { protected $config; /** + * A policy rule determining the cacheability of a request. + * + * @var \Drupal\Core\PageCache\RequestPolicyRuleInterface + */ + protected $requestPolicy; + + /** + * A policy rule determining the cacheability of the response. + * + * @var \Drupal\Core\PageCache\ResponsePolicyRuleInterface + */ + protected $responsePolicy; + + /** * Constructs a FinishResponseSubscriber object. * * @param LanguageManager $language_manager * The LanguageManager object for retrieving the correct language code. * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory * A config factory for retrieving required config objects. + * @param \Drupal\Core\PageCache\RequestPolicyRuleInterface $request_policy + * A policy rule determining the cacheability of a request. + * @param \Drupal\Core\PageCache\ResponsePolicyRuleInterface $response_policy + * A policy rule determining the cacheability of a response. */ - public function __construct(LanguageManager $language_manager, ConfigFactoryInterface $config_factory) { + public function __construct(LanguageManager $language_manager, ConfigFactoryInterface $config_factory, RequestPolicyRuleInterface $request_policy, ResponsePolicyRuleInterface $response_policy) { $this->languageManager = $language_manager; $this->config = $config_factory->get('system.performance'); + $this->requestPolicy = $request_policy; + $this->responsePolicy = $response_policy; } /** @@ -80,16 +102,21 @@ public function onRespond(FilterResponseEvent $event) { $response->headers->set($name, $value, FALSE); } - $is_cacheable = drupal_page_is_cacheable(); + $is_cacheable = $this->requestPolicy->apply($request) && $this->responsePolicy->apply($response, $request); // Add headers necessary to specify whether the response should be cached by // proxies and/or the browser. if ($is_cacheable && $this->config->get('cache.page.max_age') > 0) { if (!$this->isCacheControlCustomized($response)) { + // Only add the default Cache-Control header if the controller did not + // specify one on the response. $this->setResponseCacheable($response, $request); } } else { + // If either the policy forbids caching or the sites configuration does + // not allow to add a max-age directive, then enforce a Cache-Control + // header declaring the response as not cacheable. $this->setResponseNotCacheable($response, $request); } diff --git a/core/lib/Drupal/Core/PageCache/DefaultRequestPolicy.php b/core/lib/Drupal/Core/PageCache/DefaultRequestPolicy.php new file mode 100644 index 0000000..3f7e846 --- /dev/null +++ b/core/lib/Drupal/Core/PageCache/DefaultRequestPolicy.php @@ -0,0 +1,27 @@ +deny(new RequestPolicyRule\CommandLineOrUnsafeMethod()); + $this->allow(new RequestPolicyRule\NoSessionOpen()); + } + +} diff --git a/core/lib/Drupal/Core/PageCache/DefaultResponsePolicy.php b/core/lib/Drupal/Core/PageCache/DefaultResponsePolicy.php new file mode 100644 index 0000000..ffdf15f --- /dev/null +++ b/core/lib/Drupal/Core/PageCache/DefaultResponsePolicy.php @@ -0,0 +1,28 @@ +deny(new ResponsePolicyRule\IsBinaryFileResponse()); + $this->deny(new ResponsePolicyRule\IsStreamedResponse()); + } + +} diff --git a/core/lib/Drupal/Core/PageCache/RequestPolicy.php b/core/lib/Drupal/Core/PageCache/RequestPolicy.php new file mode 100644 index 0000000..c4fa1d0 --- /dev/null +++ b/core/lib/Drupal/Core/PageCache/RequestPolicy.php @@ -0,0 +1,80 @@ +deny as $rule) { + if ($rule->apply($request)) { + return FALSE; + } + } + + foreach ($this->allow as $rule) { + if ($rule->apply($request)) { + return TRUE; + } + } + + return FALSE; + } + + /** + * Add one policy rule to the deny-chain. + * + * @param \Drupal\Core\PageCache\RequestPolicyRuleInterface $rule + * The rules to add to the deny-chain. + * + * @return \Drupal\Core\PageCache\RequestPolicy + * This policy instance. + */ + public function deny(RequestPolicyRuleInterface $rule) { + $this->deny[spl_object_hash($rule)] = $rule; + return $this; + } + + /** + * Add one policy rule to the allow-chain. + * + * @param \Drupal\Core\PageCache\RequestPolicyRuleInterface $rule + * The rules to add to the deny-chain. + * + * @return \Drupal\Core\PageCache\RequestPolicy + * This policy instance. + */ + public function allow(RequestPolicyRuleInterface $rule) { + $this->allow[spl_object_hash($rule)] = $rule; + return $this; + } + +} diff --git a/core/lib/Drupal/Core/PageCache/RequestPolicyRule/CommandLineOrUnsafeMethod.php b/core/lib/Drupal/Core/PageCache/RequestPolicyRule/CommandLineOrUnsafeMethod.php new file mode 100644 index 0000000..7db44c3 --- /dev/null +++ b/core/lib/Drupal/Core/PageCache/RequestPolicyRule/CommandLineOrUnsafeMethod.php @@ -0,0 +1,37 @@ +isCliRequest($request) || !$request->isMethodSafe(); + } + + /** + * Indicates whether this is a CLI request. + */ + protected function isCliRequest(Request $request) { + return drupal_is_cli(); + } + +} diff --git a/core/lib/Drupal/Core/PageCache/RequestPolicyRule/NoSessionOpen.php b/core/lib/Drupal/Core/PageCache/RequestPolicyRule/NoSessionOpen.php new file mode 100644 index 0000000..e048d8a --- /dev/null +++ b/core/lib/Drupal/Core/PageCache/RequestPolicyRule/NoSessionOpen.php @@ -0,0 +1,30 @@ +cookies->has(session_name()); + } + +} diff --git a/core/lib/Drupal/Core/PageCache/RequestPolicyRuleInterface.php b/core/lib/Drupal/Core/PageCache/RequestPolicyRuleInterface.php new file mode 100644 index 0000000..4336dc8 --- /dev/null +++ b/core/lib/Drupal/Core/PageCache/RequestPolicyRuleInterface.php @@ -0,0 +1,28 @@ +deny as $rule) { + if ($rule->apply($response, $request)) { + return FALSE; + } + } + + return TRUE; + } + + /** + * Add one policy rule to the deny-chain. + * + * @param \Drupal\Core\PageCache\ResponsePolicyRuleInterface $rule + * The rules to add to the deny-chain. + * + * @return \Drupal\Core\PageCache\ResponsePolicy + * This policy instance. + */ + public function deny(ResponsePolicyRuleInterface $rule) { + $this->deny[spl_object_hash($rule)] = $rule; + return $this; + } + +} diff --git a/core/lib/Drupal/Core/PageCache/ResponsePolicyRule/IsBinaryFileResponse.php b/core/lib/Drupal/Core/PageCache/ResponsePolicyRule/IsBinaryFileResponse.php new file mode 100644 index 0000000..b928c8c --- /dev/null +++ b/core/lib/Drupal/Core/PageCache/ResponsePolicyRule/IsBinaryFileResponse.php @@ -0,0 +1,27 @@ +kill; + } + + /** + * Deny any page caching on the current request. + */ + public function trigger() { + $this->kill = TRUE; + } + +} diff --git a/core/lib/Drupal/Core/PageCache/ResponsePolicyRuleInterface.php b/core/lib/Drupal/Core/PageCache/ResponsePolicyRuleInterface.php new file mode 100644 index 0000000..86ec452 --- /dev/null +++ b/core/lib/Drupal/Core/PageCache/ResponsePolicyRuleInterface.php @@ -0,0 +1,31 @@ +start(); - if ($user->isAuthenticated() || !$this->isSessionObsolete()) { - drupal_page_is_cacheable(FALSE); - } } else { // Set a session identifier for this request. This is necessary because diff --git a/core/modules/toolbar/src/Controller/ToolbarController.php b/core/modules/toolbar/src/Controller/ToolbarController.php index 11d17b4..5d47072 100644 --- a/core/modules/toolbar/src/Controller/ToolbarController.php +++ b/core/modules/toolbar/src/Controller/ToolbarController.php @@ -23,10 +23,22 @@ class ToolbarController extends ControllerBase { * @return \Symfony\Component\HttpFoundation\JsonResponse */ public function subtreesJsonp() { - _toolbar_initialize_page_cache(); $subtrees = toolbar_get_rendered_subtrees(); $response = new JsonResponse($subtrees); $response->setCallback('Drupal.toolbar.setSubtrees.resolve'); + + // The Expires HTTP header is the heart of the client-side HTTP caching. The + // additional server-side page cache only takes effect when the client + // accesses the callback URL again (e.g., after clearing the browser cache + // or when force-reloading a Drupal page). + $max_age = 365 * 24 * 60 * 60; + $response->setPrivate(); + $response->setMaxAge($max_age); + + $expires = new \DateTime(); + $expires->setTimestamp(REQUEST_TIME + $max_age); + $response->setExpires($expires); + return $response; } diff --git a/core/modules/toolbar/src/PageCache/IsToolbarPath.php b/core/modules/toolbar/src/PageCache/IsToolbarPath.php new file mode 100644 index 0000000..ae4e408 --- /dev/null +++ b/core/modules/toolbar/src/PageCache/IsToolbarPath.php @@ -0,0 +1,28 @@ +getPathInfo(), '/toolbar/subtrees/') === 0; + } + +} diff --git a/core/modules/toolbar/toolbar.module b/core/modules/toolbar/toolbar.module index 131a1a5..c2d75fa 100644 --- a/core/modules/toolbar/toolbar.module +++ b/core/modules/toolbar/toolbar.module @@ -107,43 +107,6 @@ function toolbar_element_info() { } /** - * Use Drupal's page cache for toolbar/subtrees/*, even for authenticated users. - * - * This gets invoked after full bootstrap, so must duplicate some of what's - * done by _drupal_bootstrap_page_cache(). - * - * @todo Replace this hack with something better integrated with DrupalKernel - * once Drupal's page caching itself is properly integrated. - */ -function _toolbar_initialize_page_cache() { - $GLOBALS['conf']['system.performance']['cache']['page']['enabled'] = TRUE; - drupal_page_is_cacheable(TRUE); - - // If we have a cache, serve it. - // @see _drupal_bootstrap_page_cache() - $request = \Drupal::request(); - $response = drupal_page_get_cache($request); - if ($response) { - $response->headers->set('X-Drupal-Cache', 'HIT'); - - drupal_serve_page_from_cache($response, $request); - - $response->prepare($request); - $response->send(); - // We are done. - exit; - } - - // The Expires HTTP header is the heart of the client-side HTTP caching. The - // additional server-side page cache only takes effect when the client - // accesses the callback URL again (e.g., after clearing the browser cache or - // when force-reloading a Drupal page). - $max_age = 3600 * 24 * 365; - drupal_add_http_header('Expires', gmdate(DATE_RFC1123, REQUEST_TIME + $max_age)); - drupal_add_http_header('Cache-Control', 'private, max-age=' . $max_age); -} - -/** * Implements hook_page_build(). * * Add admin toolbar to the page_top region automatically. diff --git a/core/modules/toolbar/toolbar.services.yml b/core/modules/toolbar/toolbar.services.yml index 7f26968..10fad41 100644 --- a/core/modules/toolbar/toolbar.services.yml +++ b/core/modules/toolbar/toolbar.services.yml @@ -6,3 +6,7 @@ services: factory_method: get factory_service: cache_factory arguments: [toolbar] + toolbar.page_cache_request_policy.toolbar_path: + class: Drupal\toolbar\PageCache\IsToolbarPath + tags: + - { name: page_cache_request_policy_allow}