diff --git a/core/core.services.yml b/core/core.services.yml
index a7a2b3bdbce9a606ca54015f55de37c7febf5a64..8ce9b11e3b858e73cbcd618ffdbbd1d446eef116 100644
--- a/core/core.services.yml
+++ b/core/core.services.yml
@@ -6,26 +6,86 @@ parameters:
factory.keyvalue.expirable:
default: keyvalue.expirable.database
services:
- cache_factory:
- class: Drupal\Core\Cache\CacheFactory
- arguments: ['@settings', '%cache_default_bin_backends%']
- calls:
- - [setContainer, ['@service_container']]
- cache_contexts:
- class: Drupal\Core\Cache\CacheContexts
- arguments: ['@service_container', '%cache_contexts%' ]
+ # Simple cache contexts, directly derived from the request context.
+ cache_context.ip:
+ class: Drupal\Core\Cache\IpCacheContext
+ arguments: ['@request_stack']
+ tags:
+ - { name: cache.context }
+ cache_context.headers:
+ class: Drupal\Core\Cache\HeadersCacheContext
+ arguments: ['@request_stack']
+ tags:
+ - { name: cache.context }
+ cache_context.cookies:
+ class: Drupal\Core\Cache\CookiesCacheContext
+ arguments: ['@request_stack']
+ tags:
+ - { name: cache.context }
+ cache_context.request_format:
+ class: Drupal\Core\Cache\RequestFormatCacheContext
+ arguments: ['@request_stack']
+ tags:
+ - { name: cache.context }
cache_context.url:
class: Drupal\Core\Cache\UrlCacheContext
arguments: ['@request_stack']
tags:
- - { name: cache.context}
- cache_context.pager:
- class: Drupal\Core\Cache\PagerCacheContext
+ - { name: cache.context }
+ cache_context.url.host:
+ class: Drupal\Core\Cache\HostCacheContext
arguments: ['@request_stack']
+ tags:
+ - { name: cache.context }
+ cache_context.url.query_args:
+ class: Drupal\Core\Cache\QueryArgsCacheContext
+ arguments: ['@request_stack']
+ tags:
+ - { name: cache.context }
+ cache_context.url.query_args.pagers:
+ class: Drupal\Core\Cache\PagersCacheContext
+ arguments: ['@request_stack']
+ tags:
+ - { name: cache.context }
+
+ # Complex cache contexts, that depend on the routing system.
+ cache_context.route:
+ class: Drupal\Core\Cache\RouteCacheContext
+ arguments: ['@current_route_match']
+ tags:
+ - { name: cache.context }
+ cache_context.route.name:
+ class: Drupal\Core\Cache\RouteNameCacheContext
+ arguments: ['@current_route_match']
+ tags:
+ - { name: cache.context }
+ cache_context.route.menu_active_trails:
+ class: Drupal\Core\Cache\MenuActiveTrailsCacheContext
+ calls:
+ - [setContainer, ['@service_container']]
+ tags:
+ - { name: cache.context }
+
+ # Complex cache contexts, that may be calculated from a combination of
+ # multiple aspects of the request context plus additional logic. Hence they
+ # are their own roots.
+ cache_context.user:
+ class: Drupal\Core\Cache\UserCacheContext
+ arguments: ['@current_user']
+ tags:
+ - { name: cache.context}
+ cache_context.user.roles:
+ class: Drupal\Core\Cache\UserRolesCacheContext
+ arguments: ['@current_user']
tags:
- { name: cache.context}
- cache_context.language:
- class: Drupal\Core\Cache\LanguageCacheContext
+ cache_context.user.is_super_user:
+ class: Drupal\Core\Cache\IsSuperUserCacheContext
+ arguments: ['@current_user']
+ tags:
+ - { name: cache.context}
+ cache_context.languages:
+ class: Drupal\Core\Cache\LanguagesCacheContext
arguments: ['@language_manager']
tags:
- { name: cache.context}
@@ -38,12 +98,15 @@ services:
class: Drupal\Core\Cache\TimeZoneCacheContext
tags:
- { name: cache.context}
- cache_context.menu.active_trail:
- class: Drupal\Core\Cache\MenuActiveTrailCacheContext
+
+ cache_factory:
+ class: Drupal\Core\Cache\CacheFactory
+ arguments: ['@settings', '%cache_default_bin_backends%']
calls:
- [setContainer, ['@service_container']]
- tags:
- - { name: cache.context}
+ cache_contexts:
+ class: Drupal\Core\Cache\CacheContexts
+ arguments: ['@service_container', '%cache_contexts%' ]
cache_tags.invalidator:
parent: container.trait
class: Drupal\Core\Cache\CacheTagsInvalidator
@@ -779,7 +842,7 @@ services:
- { name: event_subscriber }
main_content_renderer.html:
class: Drupal\Core\Render\MainContent\HtmlRenderer
- arguments: ['@title_resolver', '@plugin.manager.display_variant', '@event_dispatcher', '@module_handler', '@renderer']
+ arguments: ['@title_resolver', '@plugin.manager.display_variant', '@event_dispatcher', '@module_handler', '@renderer', '@cache_contexts']
tags:
- { name: render.main_content_renderer, format: html }
main_content_renderer.ajax:
diff --git a/core/lib/Drupal/Core/Block/BlockBase.php b/core/lib/Drupal/Core/Block/BlockBase.php
index b8a7999d2fd34d910ab60c177de81c8b859b41d1..9872481caa87b147ca82ea79e66bfcf6b14790ec 100644
--- a/core/lib/Drupal/Core/Block/BlockBase.php
+++ b/core/lib/Drupal/Core/Block/BlockBase.php
@@ -207,7 +207,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta
$contexts = \Drupal::service("cache_contexts")->getLabels();
// Blocks are always rendered in the "per language" and "per theme" cache
// contexts. No need to show those options to the end user.
- unset($contexts['language']);
+ unset($contexts['languages']);
unset($contexts['theme']);
$form['cache']['contexts'] = array(
'#type' => 'checkboxes',
diff --git a/core/lib/Drupal/Core/Cache/CacheContexts.php b/core/lib/Drupal/Core/Cache/CacheContexts.php
index 33f86b1d91879a86456950931e4555a5a2b3b4ba..781f24a8a2257e25956756327a33580a70d32857 100644
--- a/core/lib/Drupal/Core/Cache/CacheContexts.php
+++ b/core/lib/Drupal/Core/Cache/CacheContexts.php
@@ -105,6 +105,7 @@ public function getLabels($include_calculated_cache_contexts = FALSE) {
* @throws \InvalidArgumentException
*/
public function convertTokensToKeys(array $context_tokens) {
+ $context_tokens = $this->optimizeTokens($context_tokens);
sort($context_tokens);
$keys = [];
foreach (static::parseTokens($context_tokens) as $context) {
@@ -117,6 +118,69 @@ public function convertTokensToKeys(array $context_tokens) {
return $keys;
}
+ /**
+ * Optimizes cache context tokens (the minimal representative subset).
+ *
+ * A minimal representative subset means that any cache context token in the
+ * given set of cache context tokens that is a property of another cache
+ * context cache context token in the set, is removed.
+ *
+ * Hence a minimal representative subset is the most compact representation
+ * possible of a set of cache context tokens, that still captures the entire
+ * universe of variations.
+ *
+ * E.g. when caching per user ('user'), also caching per role ('user.roles')
+ * is meaningless because "per role" is implied by "per user".
+ *
+ * Examples — remember that the period indicates hierarchy and the colon can
+ * be used to get a specific value of a calculated cache context:
+ * - ['a', 'a.b'] -> ['a']
+ * - ['a', 'a.b.c'] -> ['a']
+ * - ['a.b', 'a.b.c'] -> ['a.b']
+ * - ['a', 'a.b', 'a.b.c'] -> ['a']
+ * - ['x', 'x:foo'] -> ['x']
+ * - ['a', 'a.b.c:bar'] -> ['a']
+ *
+ * @param string[] $context_tokens
+ * A set of cache context tokens.
+ *
+ * @return string[]
+ * A representative subset of the given set of cache context tokens..
+ */
+ public function optimizeTokens(array $context_tokens) {
+ $optimized_content_tokens = [];
+ foreach ($context_tokens as $context_token) {
+ // Context tokens without:
+ // - a period means they don't have a parent
+ // - a colon means they're not a specific value of a cache context
+ // hence no optimizations are possible.
+ if (strpos($context_token, '.') === FALSE && strpos($context_token, ':') === FALSE) {
+ $optimized_content_tokens[] = $context_token;
+ }
+ // The context token has a period or a colon. Iterate over all ancestor
+ // cache contexts. If one exists, omit the context token.
+ else {
+ $ancestor_found = FALSE;
+ // Treat a colon like a period, that allows us to consider 'a' the
+ // ancestor of 'a:foo', without any additional code for the colon.
+ $ancestor = str_replace(':', '.', $context_token);
+ do {
+ $ancestor = substr($ancestor, 0, strrpos($ancestor, '.'));
+ if (in_array($ancestor, $context_tokens)) {
+ // An ancestor cache context is in $context_tokens, hence this cache
+ // context is implied.
+ $ancestor_found = TRUE;
+ }
+
+ } while(!$ancestor_found && strpos($ancestor, '.') !== FALSE);
+ if (!$ancestor_found) {
+ $optimized_content_tokens[] = $context_token;
+ }
+ }
+ }
+ return $optimized_content_tokens;
+ }
+
/**
* Retrieves a cache context service from the container.
*
diff --git a/core/lib/Drupal/Core/Cache/CacheContextsPass.php b/core/lib/Drupal/Core/Cache/CacheContextsPass.php
index b1cb74e6886fa0c8218f0e81307c248735063e28..576b2b568fca8592140319627b57218950a5e150 100644
--- a/core/lib/Drupal/Core/Cache/CacheContextsPass.php
+++ b/core/lib/Drupal/Core/Cache/CacheContextsPass.php
@@ -28,6 +28,20 @@ public function process(ContainerBuilder $container) {
}
$cache_contexts[] = substr($id, 14);
}
+
+ // Validate.
+ sort($cache_contexts);
+ foreach ($cache_contexts as $id) {
+ // Validate the hierarchy of non-root-level cache contexts.
+ if (strpos($id, '.') !== FALSE) {
+ $parent = substr($id, 0, strrpos($id, '.'));
+ if (!in_array($parent, $cache_contexts)) {
+ throw new \InvalidArgumentException(sprintf('The service "%s" has an invalid service ID: the period indicates the hierarchy of cache contexts, therefore "%s" is considered the parent cache context, but no cache context service with that name was found.', $id, $parent));
+ }
+ }
+ }
+
+
$container->setParameter('cache_contexts', $cache_contexts);
}
diff --git a/core/lib/Drupal/Core/Cache/CalculatedCacheContextInterface.php b/core/lib/Drupal/Core/Cache/CalculatedCacheContextInterface.php
index 795a512e72f993a03931573389ed49b0cd323065..38114c363cf5716692eef149244c5b5094ad6b5b 100644
--- a/core/lib/Drupal/Core/Cache/CalculatedCacheContextInterface.php
+++ b/core/lib/Drupal/Core/Cache/CalculatedCacheContextInterface.php
@@ -28,12 +28,13 @@ public static function getLabel();
* A cache context service's name is used as a token (placeholder) cache key,
* and is then replaced with the string returned by this method.
*
- * @param string $parameter
- * The parameter.
+ * @param string|null $parameter
+ * The parameter, or NULL to indicate all possible parameter values.
*
* @return string
- * The string representation of the cache context.
+ * The string representation of the cache context. When $parameter is NULL,
+ * a value representing all possible parameters must be generated.
*/
- public function getContext($parameter);
+ public function getContext($parameter = NULL);
}
diff --git a/core/lib/Drupal/Core/Cache/CookiesCacheContext.php b/core/lib/Drupal/Core/Cache/CookiesCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..6760b1b5c5a69e5fdc044705f650677b0e4f5456
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/CookiesCacheContext.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\CookiesCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the CookiesCacheContext service, for "per cookie" caching.
+ */
+class CookiesCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('HTTP cookies');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext($cookie = NULL) {
+ if ($cookie === NULL) {
+ return $this->requestStack->getCurrentRequest()->cookies->all();
+ }
+ else {
+ return $this->requestStack->getCurrentRequest()->cookies->get($cookie);
+ }
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/HeadersCacheContext.php b/core/lib/Drupal/Core/Cache/HeadersCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..e2b8932dab244e56c103fceeae7f1ffc4446f42c
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/HeadersCacheContext.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\HeadersCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the HeadersCacheContext service, for "per header" caching.
+ */
+class HeadersCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('HTTP headers');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext($header = NULL) {
+ if ($header === NULL) {
+ return $this->requestStack->getCurrentRequest()->headers->all();
+ }
+ else {
+ return $this->requestStack->getCurrentRequest()->headers->get($header);
+ }
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/HostCacheContext.php b/core/lib/Drupal/Core/Cache/HostCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..8a3af00bee156853fe0799b60ad6c1d603fc4608
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/HostCacheContext.php
@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\HostCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the HostCacheContext service, for "per host" caching.
+ *
+ * A "host" is defined as the combination of URI scheme, domain name and port.
+ *
+ * @see Symfony\Component\HttpFoundation::getSchemeAndHttpHost()
+ */
+class HostCacheContext extends RequestStackCacheContextBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('Host');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext() {
+ return $this->requestStack->getCurrentRequest()->getSchemeAndHttpHost();
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/IpCacheContext.php b/core/lib/Drupal/Core/Cache/IpCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..c0c2e08020fb08a30a73be9e500a9921d3146044
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/IpCacheContext.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\IpCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the IpCacheContext service, for "per IP address" caching.
+ */
+class IpCacheContext extends RequestStackCacheContextBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('IP address');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext() {
+ return $this->requestStack->getCurrentRequest()->getClientIp();
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/IsSuperUserCacheContext.php b/core/lib/Drupal/Core/Cache/IsSuperUserCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..65697155357f7b0725573b3fb08be24141205195
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/IsSuperUserCacheContext.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\IsSuperUserCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the IsSuperUserCacheContext service, for "super user or not" caching.
+ */
+class IsSuperUserCacheContext extends UserCacheContext {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('Is super user');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext() {
+ return ((int) $this->user->id()) === 1 ? '1' : '0';
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/LanguageCacheContext.php b/core/lib/Drupal/Core/Cache/LanguageCacheContext.php
deleted file mode 100644
index b9d19a72d9c94f725b44fd116892c02f0de5bec6..0000000000000000000000000000000000000000
--- a/core/lib/Drupal/Core/Cache/LanguageCacheContext.php
+++ /dev/null
@@ -1,57 +0,0 @@
-<?php
-
-/**
- * @file
- * Contains \Drupal\Core\Cache\LanguageCacheContext.
- */
-
-namespace Drupal\Core\Cache;
-
-use Drupal\Core\Language\LanguageManagerInterface;
-
-/**
- * Defines the LanguageCacheContext service, for "per language" caching.
- */
-class LanguageCacheContext implements CacheContextInterface {
-
- /**
- * The language manager.
- *
- * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
- */
- protected $languageManager;
-
- /**
- * Constructs a new LanguageCacheContext service.
- *
- * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
- * The language manager.
- */
- public function __construct(LanguageManagerInterface $language_manager) {
- $this->languageManager = $language_manager;
- }
-
- /**
- * {@inheritdoc}
- */
- public static function getLabel() {
- return t('Language');
- }
-
- /**
- * {@inheritdoc}
- */
- public function getContext() {
- $context_parts = array();
- if ($this->languageManager->isMultilingual()) {
- foreach ($this->languageManager->getLanguageTypes() as $type) {
- $context_parts[] = $this->languageManager->getCurrentLanguage($type)->getId();
- }
- }
- else {
- $context_parts[] = $this->languageManager->getCurrentLanguage()->getId();
- }
- return implode(':', $context_parts);
- }
-
-}
diff --git a/core/lib/Drupal/Core/Cache/LanguagesCacheContext.php b/core/lib/Drupal/Core/Cache/LanguagesCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..2ed15177672d09ef2942321c13ad69bdf8384bea
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/LanguagesCacheContext.php
@@ -0,0 +1,76 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\LanguagesCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+use Drupal\Core\Language\LanguageManagerInterface;
+
+/**
+ * Defines the LanguagesCacheContext service, for "per language" caching.
+ */
+class LanguagesCacheContext implements CalculatedCacheContextInterface {
+
+ /**
+ * The language manager.
+ *
+ * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
+ */
+ protected $languageManager;
+
+ /**
+ * Constructs a new LanguagesCacheContext service.
+ *
+ * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
+ * The language manager.
+ */
+ public function __construct(LanguageManagerInterface $language_manager) {
+ $this->languageManager = $language_manager;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('Language');
+ }
+
+ /**
+ * {@inheritdoc}
+ *
+ * $type can be NULL, or one of the language types supported by the language
+ * manager, typically:
+ * - LanguageInterface::TYPE_INTERFACE
+ * - LanguageInterface::TYPE_CONTENT
+ * - LanguageInterface::TYPE_URL
+ *
+ * @see \Drupal\Core\Language\LanguageManagerInterface::getLanguageTypes()
+ *
+ * @throws \RuntimeException
+ * In case an invalid language type is specified.
+ */
+ public function getContext($type = NULL) {
+ if ($type === NULL) {
+ $context_parts = array();
+ if ($this->languageManager->isMultilingual()) {
+ foreach ($this->languageManager->getLanguageTypes() as $type) {
+ $context_parts[] = $this->languageManager->getCurrentLanguage($type)->getId();
+ }
+ }
+ else {
+ $context_parts[] = $this->languageManager->getCurrentLanguage()->getId();
+ }
+ return implode(',', $context_parts);
+ }
+ else {
+ if (!in_array($type, $this->languageManager->getLanguageTypes())) {
+ throw new \RuntimeException(sprintf('The language type "%s" is invalid.', $type));
+ }
+ return $this->languageManager->getCurrentLanguage($type)->getId();
+ }
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/MenuActiveTrailCacheContext.php b/core/lib/Drupal/Core/Cache/MenuActiveTrailsCacheContext.php
similarity index 68%
rename from core/lib/Drupal/Core/Cache/MenuActiveTrailCacheContext.php
rename to core/lib/Drupal/Core/Cache/MenuActiveTrailsCacheContext.php
index 7c41bee2a8e00922eb4bece18a28e9ce8bdc6daa..3b43178a31b8c0dbc37db1355e92b82212d244cd 100644
--- a/core/lib/Drupal/Core/Cache/MenuActiveTrailCacheContext.php
+++ b/core/lib/Drupal/Core/Cache/MenuActiveTrailsCacheContext.php
@@ -2,7 +2,7 @@
/**
* @file
- * Contains \Drupal\Core\Cache\MenuActiveTrailCacheContext.
+ * Contains \Drupal\Core\Cache\MenuActiveTrailsCacheContext.
*/
namespace Drupal\Core\Cache;
@@ -10,12 +10,12 @@
use Symfony\Component\DependencyInjection\ContainerAware;
/**
- * Defines the MenuActiveTrailCacheContext service.
+ * Defines the MenuActiveTrailsCacheContext service.
*
* This class is container-aware to avoid initializing the 'menu.active_trail'
* service (and its dependencies) when it is not necessary.
*/
-class MenuActiveTrailCacheContext extends ContainerAware implements CalculatedCacheContextInterface {
+class MenuActiveTrailsCacheContext extends ContainerAware implements CalculatedCacheContextInterface {
/**
* {@inheritdoc}
@@ -27,7 +27,7 @@ public static function getLabel() {
/**
* {@inheritdoc}
*/
- public function getContext($menu_name) {
+ public function getContext($menu_name = NULL) {
$active_trail = $this->container->get('menu.active_trail')
->getActiveTrailIds($menu_name);
return 'menu_trail.' . $menu_name . '|' . implode('|', $active_trail);
diff --git a/core/lib/Drupal/Core/Cache/PagerCacheContext.php b/core/lib/Drupal/Core/Cache/PagerCacheContext.php
deleted file mode 100644
index a4c308c84b31ed860aceef7db25a820fe64be8ad..0000000000000000000000000000000000000000
--- a/core/lib/Drupal/Core/Cache/PagerCacheContext.php
+++ /dev/null
@@ -1,29 +0,0 @@
-<?php
-
-/**
- * @file
- * Contains \Drupal\Core\Cache\PagerCacheContext.
- */
-
-namespace Drupal\Core\Cache;
-
-/**
- * Defines a cache context for "per page in a pager" caching.
- */
-class PagerCacheContext implements CalculatedCacheContextInterface {
-
- /**
- * {@inheritdoc}
- */
- public static function getLabel() {
- return t('Pager');
- }
-
- /**
- * {@inheritdoc}
- */
- public function getContext($pager_id) {
- return 'pager.' . $pager_id . '.' . pager_find_page($pager_id);
- }
-
-}
diff --git a/core/lib/Drupal/Core/Cache/PagersCacheContext.php b/core/lib/Drupal/Core/Cache/PagersCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..cd9bb98895e3509f585ea5d70b5cd77b6201caab
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/PagersCacheContext.php
@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\PagersCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines a cache context for "per page in a pager" caching.
+ */
+class PagersCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('Pager');
+ }
+
+ /**
+ * {@inheritdoc}
+ *
+ * @see pager_find_page()
+ */
+ public function getContext($pager_id = NULL) {
+ // The value of the 'page' query argument contains the information that
+ // controls *all* pagers.
+ if ($pager_id === NULL) {
+ return 'pager' . $this->requestStack->getCurrentRequest()->query->get('page', '');
+ }
+
+ return 'pager.' . $pager_id . '.' . pager_find_page($pager_id);
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/QueryArgsCacheContext.php b/core/lib/Drupal/Core/Cache/QueryArgsCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..4c34721d74d7aa51b8a206cfe165b2d601f1d7f7
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/QueryArgsCacheContext.php
@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\QueryArgsCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the QueryArgsCacheContext service, for "per query args" caching.
+ *
+ * A "host" is defined as the combination of URI scheme, domain name and port.
+ *
+ * @see Symfony\Component\HttpFoundation::getSchemeAndHttpHost()
+ */
+class QueryArgsCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('Query arguments');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext($query_arg = NULL) {
+ if ($query_arg === NULL) {
+ return $this->requestStack->getCurrentRequest()->getQueryString();
+ }
+ else {
+ return $this->requestStack->getCurrentRequest()->query->get($query_arg);
+ }
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/RequestFormatCacheContext.php b/core/lib/Drupal/Core/Cache/RequestFormatCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..397384fbcf7c033cbc2cdf53a4aa097f9f9fce9a
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/RequestFormatCacheContext.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\RequestFormatCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the RequestFormatCacheContext service, for "per format" caching.
+ */
+class RequestFormatCacheContext extends RequestStackCacheContextBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('Request format');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext() {
+ return $this->requestStack->getCurrentRequest()->getRequestFormat();
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/RequestStackCacheContextBase.php b/core/lib/Drupal/Core/Cache/RequestStackCacheContextBase.php
new file mode 100644
index 0000000000000000000000000000000000000000..34e3560c2ba596a29e33c7789811ed907403689c
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/RequestStackCacheContextBase.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\RequestStackCacheContextBase.
+ */
+
+namespace Drupal\Core\Cache;
+
+use Symfony\Component\HttpFoundation\RequestStack;
+
+/**
+ * Defines a base class for cache contexts depending only on the request stack.
+ */
+abstract class RequestStackCacheContextBase implements CacheContextInterface {
+
+ /**
+ * The request stack.
+ *
+ * @var \Symfony\Component\HttpFoundation\RequestStack
+ */
+ protected $requestStack;
+
+ /**
+ * Constructs a new RequestStackCacheContextBase class.
+ *
+ * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
+ * The request stack.
+ */
+ public function __construct(RequestStack $request_stack) {
+ $this->requestStack = $request_stack;
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/RouteCacheContext.php b/core/lib/Drupal/Core/Cache/RouteCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..6e9e39f4e9ed507b1d272df43b77cba34952f3bf
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/RouteCacheContext.php
@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\RouteCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+use Drupal\Core\Routing\RouteMatchInterface;
+
+/**
+ * Defines the RouteCacheContext service, for "per route" caching.
+ */
+class RouteCacheContext {
+
+ /**
+ * The route match.
+ *
+ * @var \Drupal\Core\Routing\RouteMatchInterface
+ */
+ protected $routeMatch;
+
+ /**
+ * Constructs a new RouteCacheContext class.
+ *
+ * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
+ * The route match.
+ */
+ public function __construct(RouteMatchInterface $route_match) {
+ $this->routeMatch = $route_match;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('Route');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext() {
+ return $this->routeMatch->getRouteName() . hash('sha256', serialize($this->routeMatch->getRawParameters()->all()));
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/RouteNameCacheContext.php b/core/lib/Drupal/Core/Cache/RouteNameCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..f0bd93788108f8ff908705fcaffbdeedc09922dc
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/RouteNameCacheContext.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\RouteNameCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the RouteCacheContext service, for "per route name" caching.
+ */
+class RouteNameCacheContext extends RouteCacheContext {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t('Route name');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext() {
+ return $this->routeMatch->getRouteName();
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Cache/UrlCacheContext.php b/core/lib/Drupal/Core/Cache/UrlCacheContext.php
index 308d1827970330fd058126a7a93f832ce9160ed1..138109317d3890d95073ec030656d356b979e280 100644
--- a/core/lib/Drupal/Core/Cache/UrlCacheContext.php
+++ b/core/lib/Drupal/Core/Cache/UrlCacheContext.php
@@ -7,29 +7,10 @@
namespace Drupal\Core\Cache;
-use Symfony\Component\HttpFoundation\RequestStack;
-
/**
* Defines the UrlCacheContext service, for "per page" caching.
*/
-class UrlCacheContext implements CacheContextInterface {
-
- /**
- * The request stack.
- *
- * @var \Symfony\Component\HttpFoundation\RequestStack
- */
- protected $requestStack;
-
- /**
- * Constructs a new UrlCacheContext service.
- *
- * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
- * The request stack.
- */
- public function __construct(RequestStack $request_stack) {
- $this->requestStack = $request_stack;
- }
+class UrlCacheContext extends RequestStackCacheContextBase {
/**
* {@inheritdoc}
diff --git a/core/modules/user/src/Cache/UserCacheContext.php b/core/lib/Drupal/Core/Cache/UserCacheContext.php
similarity index 83%
rename from core/modules/user/src/Cache/UserCacheContext.php
rename to core/lib/Drupal/Core/Cache/UserCacheContext.php
index d9d880ed700f2c593ad557a5ad05634abede6b9a..d5e282553979221d5b0fd6951950f69df64ce80b 100644
--- a/core/modules/user/src/Cache/UserCacheContext.php
+++ b/core/lib/Drupal/Core/Cache/UserCacheContext.php
@@ -2,12 +2,11 @@
/**
* @file
- * Contains \Drupal\user\Cache\UserCacheContext.
+ * Contains \Drupal\Core\Cache\UserCacheContext.
*/
-namespace Drupal\user\Cache;
+namespace Drupal\Core\Cache;
-use Drupal\Core\Cache\CacheContextInterface;
use Drupal\Core\Session\AccountInterface;
/**
diff --git a/core/lib/Drupal/Core/Cache/UserRolesCacheContext.php b/core/lib/Drupal/Core/Cache/UserRolesCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..cf7b4507b0f21521a1f590738cd9b60fc1ae9143
--- /dev/null
+++ b/core/lib/Drupal/Core/Cache/UserRolesCacheContext.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\UserRolesCacheContext.
+ */
+
+namespace Drupal\Core\Cache;
+
+/**
+ * Defines the UserRolesCacheContext service, for "per role" caching.
+ */
+class UserRolesCacheContext extends UserCacheContext implements CalculatedCacheContextInterface{
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t("User's roles");
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext($role = NULL) {
+ if ($role === NULL) {
+ return 'r.' . implode(',', $this->user->getRoles());
+ }
+ else {
+ return 'r.' . $role . '.' . (in_array($role, $this->user->getRoles()) ? '0' : '1');
+ }
+ }
+
+}
diff --git a/core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/LanguageFormatter.php b/core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/LanguageFormatter.php
index d142872136bec765dd748ab85062384de3f3984c..fbf120619781f255651f455ccea67e0656ab15d6 100644
--- a/core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/LanguageFormatter.php
+++ b/core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/LanguageFormatter.php
@@ -117,7 +117,7 @@ public function settingsSummary() {
* {@inheritdoc}
*/
protected function viewValue(FieldItemInterface $item) {
- // The language cache context is not necessary because the language is
+ // The 'languages' cache context is not necessary because the language is
// either displayed in its configured form (loaded directly from config
// storage by LanguageManager::getLanguages()) or in its native language
// name. That only depends on formatter settings and no language condition.
diff --git a/core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php b/core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php
index 49f4e99d5b6337ecd0b417dafca5a52348bb0eef..be32e641df06bac60fac234f41480363b52a7c9f 100644
--- a/core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php
+++ b/core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php
@@ -18,8 +18,9 @@ interface MenuActiveTrailInterface {
/**
* Gets the active trail IDs of the specified menu tree.
*
- * @param string $menu_name
- * The menu name of the requested tree.
+ * @param string|NULL $menu_name
+ * (optional) The menu name of the requested tree. If omitted, all menu
+ * trees will be searched.
*
* @return array
* An array containing the active trail: a list of plugin IDs.
diff --git a/core/lib/Drupal/Core/Render/Element/Pager.php b/core/lib/Drupal/Core/Render/Element/Pager.php
index 006064a6d781759ea9f7cfd3a7756e1dd34ca9df..eeb0f9dd57655052b629f3de077f77003331ffdb 100644
--- a/core/lib/Drupal/Core/Render/Element/Pager.php
+++ b/core/lib/Drupal/Core/Render/Element/Pager.php
@@ -46,7 +46,7 @@ public function getInfo() {
* @return array
*/
public static function preRenderPager(array $pager) {
- $pager['#cache']['contexts'][] = 'pager:' . $pager['#element'];
+ $pager['#cache']['contexts'][] = 'url.query_args.pagers:' . $pager['#element'];
return $pager;
}
diff --git a/core/lib/Drupal/Core/Render/MainContent/HtmlRenderer.php b/core/lib/Drupal/Core/Render/MainContent/HtmlRenderer.php
index 269b64e314562db602da0463bf7459ffac59fc56..249b47b0865e5189fd18990ac714eb89d45d8c31 100644
--- a/core/lib/Drupal/Core/Render/MainContent/HtmlRenderer.php
+++ b/core/lib/Drupal/Core/Render/MainContent/HtmlRenderer.php
@@ -10,6 +10,7 @@
use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Cache\Cache;
+use Drupal\Core\Cache\CacheContexts;
use Drupal\Core\Controller\TitleResolverInterface;
use Drupal\Core\Display\PageVariantInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
@@ -63,6 +64,13 @@ class HtmlRenderer implements MainContentRendererInterface {
*/
protected $renderer;
+ /**
+ * The cache contexts service.
+ *
+ * @var \Drupal\Core\Cache\CacheContexts
+ */
+ protected $cacheContexts;
+
/**
* Constructs a new HtmlRenderer.
*
@@ -76,13 +84,16 @@ class HtmlRenderer implements MainContentRendererInterface {
* The module handler.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer service.
+ * @param \Drupal\Core\Cache\CacheContexts $cache_contexts
+ * The cache contexts service.
*/
- public function __construct(TitleResolverInterface $title_resolver, PluginManagerInterface $display_variant_manager, EventDispatcherInterface $event_dispatcher, ModuleHandlerInterface $module_handler, RendererInterface $renderer) {
+ public function __construct(TitleResolverInterface $title_resolver, PluginManagerInterface $display_variant_manager, EventDispatcherInterface $event_dispatcher, ModuleHandlerInterface $module_handler, RendererInterface $renderer, CacheContexts $cache_contexts) {
$this->titleResolver = $title_resolver;
$this->displayVariantManager = $display_variant_manager;
$this->eventDispatcher = $event_dispatcher;
$this->moduleHandler = $module_handler;
$this->renderer = $renderer;
+ $this->cacheContexts = $cache_contexts;
}
/**
@@ -149,7 +160,7 @@ public function renderResponse(array $main_content, Request $request, RouteMatch
$response = new Response($content, 200,[
'X-Drupal-Cache-Tags' => implode(' ', $cache_tags),
- 'X-Drupal-Cache-Contexts' => implode(' ', $cache_contexts),
+ 'X-Drupal-Cache-Contexts' => implode(' ', $this->cacheContexts->optimizeTokens($cache_contexts)),
'X-Generator' => 'Drupal ' . $version . ' (https://www.drupal.org)'
]);
// If an explicit non-infinite max-age is specified by a part of the page,
diff --git a/core/modules/block/src/BlockViewBuilder.php b/core/modules/block/src/BlockViewBuilder.php
index 8430393eab69d8b759b41860bbeaa04b941ba22a..d527d6d2b8affec0af63bdadb8c10e6a9c1c178e 100644
--- a/core/modules/block/src/BlockViewBuilder.php
+++ b/core/modules/block/src/BlockViewBuilder.php
@@ -87,7 +87,7 @@ public function viewMultiple(array $entities = array(), $view_mode = 'full', $la
$entity->id(),
);
$default_cache_contexts = array(
- 'language',
+ 'languages',
'theme',
);
$max_age = $plugin->getCacheMaxAge();
diff --git a/core/modules/block/src/Tests/BlockInterfaceTest.php b/core/modules/block/src/Tests/BlockInterfaceTest.php
index 08980c5df91cf3611d205cf8fe08dbfd24aad530..37b9b3c5dab5843b4f4c008a60570de4948308fd 100644
--- a/core/modules/block/src/Tests/BlockInterfaceTest.php
+++ b/core/modules/block/src/Tests/BlockInterfaceTest.php
@@ -67,7 +67,7 @@ public function testBlockInterface() {
$period[\Drupal\Core\Cache\Cache::PERMANENT] = t('Forever');
$contexts = \Drupal::service("cache_contexts")->getLabels();
unset($contexts['theme']);
- unset($contexts['language']);
+ unset($contexts['languages']);
$expected_form = array(
'provider' => array(
'#type' => 'value',
diff --git a/core/modules/block_content/src/Tests/BlockContentCacheTagsTest.php b/core/modules/block_content/src/Tests/BlockContentCacheTagsTest.php
index 16921baa5ad0dde54afbd251391047d096dd810b..d5a98f6b6e166508e47227c4cf681ad890e0c599 100644
--- a/core/modules/block_content/src/Tests/BlockContentCacheTagsTest.php
+++ b/core/modules/block_content/src/Tests/BlockContentCacheTagsTest.php
@@ -80,7 +80,7 @@ public function testBlock() {
// Expected keys, contexts, and tags for the block.
// @see \Drupal\block\BlockViewBuilder::viewMultiple()
$expected_block_cache_keys = ['entity_view', 'block', $block->id()];
- $expected_block_cache_contexts = ['language', 'theme'];
+ $expected_block_cache_contexts = ['languages', 'theme'];
$expected_block_cache_tags = Cache::mergeTags(['block_view', 'rendered'], $block->getCacheTags(), $block->getPlugin()->getCacheTags());
// Expected contexts and tags for the BlockContent entity.
diff --git a/core/modules/book/book.services.yml b/core/modules/book/book.services.yml
index 440d021aa3143c767b0967b30b55cf9b379b03b7..89b25fc02af1b0b10cdbfd74f8d0a3237d645ce6 100644
--- a/core/modules/book/book.services.yml
+++ b/core/modules/book/book.services.yml
@@ -23,7 +23,7 @@ services:
arguments: ['@book.manager']
tags:
- { name: access_check, applies_to: _access_book_removable }
- cache_context.book.navigation:
+ cache_context.route.book_navigation:
class: Drupal\book\Cache\BookNavigationCacheContext
arguments: ['@request_stack']
tags:
diff --git a/core/modules/book/src/Plugin/Block/BookNavigationBlock.php b/core/modules/book/src/Plugin/Block/BookNavigationBlock.php
index 4ce4c3fa105dc6642712562ed6203d0552fe3b00..7b5279959ab6c9e14b1f53f0951ccbf87b52b29f 100644
--- a/core/modules/book/src/Plugin/Block/BookNavigationBlock.php
+++ b/core/modules/book/src/Plugin/Block/BookNavigationBlock.php
@@ -186,7 +186,7 @@ protected function getRequiredCacheContexts() {
// context.
return [
'user.roles',
- 'book.navigation',
+ 'route.book_navigation',
];
}
diff --git a/core/modules/filter/src/Tests/FilterAPITest.php b/core/modules/filter/src/Tests/FilterAPITest.php
index 12efba397fff672b45f3ec132d16afac86cdd179..fe54ccdc8a9cb01bf09fb7af9570c818092ab141 100644
--- a/core/modules/filter/src/Tests/FilterAPITest.php
+++ b/core/modules/filter/src/Tests/FilterAPITest.php
@@ -8,6 +8,7 @@
namespace Drupal\filter\Tests;
use Drupal\Component\Utility\String;
+use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Session\AnonymousUserSession;
use Drupal\Core\TypedData\OptionsProviderInterface;
use Drupal\Core\TypedData\DataDefinition;
@@ -260,7 +261,7 @@ function testProcessedTextElement() {
$this->assertEqual($expected_cache_tags, $build['#cache']['tags'], 'Expected cache tags present.');
$expected_cache_contexts = [
// The cache context set by the filter_test_cache_contexts filter.
- 'language',
+ 'languages:' . LanguageInterface::TYPE_CONTENT,
];
$this->assertEqual($expected_cache_contexts, $build['#cache']['contexts'], 'Expected cache contexts present.');
$expected_markup = '<p>Hello, world!</p><p>This is a dynamic llama.</p>';
diff --git a/core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestCacheContexts.php b/core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestCacheContexts.php
index 6a9895615685b527b117fe0e0b3bc74e7c2d9815..3cb6de2c89e7c8b170e7161d3ef6b4b009a717b8 100644
--- a/core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestCacheContexts.php
+++ b/core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestCacheContexts.php
@@ -7,6 +7,7 @@
namespace Drupal\filter_test\Plugin\Filter;
+use Drupal\Core\Language\LanguageInterface;
use Drupal\filter\FilterProcessResult;
use Drupal\filter\Plugin\FilterBase;
@@ -28,7 +29,7 @@ class FilterTestCacheContexts extends FilterBase {
public function process($text, $langcode) {
$result = new FilterProcessResult($text);
// The changes made by this filter are language-specific.
- $result->addCacheContexts(['language']);
+ $result->addCacheContexts(['languages:' . LanguageInterface::TYPE_CONTENT]);
return $result;
}
diff --git a/core/modules/node/node.services.yml b/core/modules/node/node.services.yml
index b2585d9d009eabc4180143ec6e5412d6a4c00d1e..f3e54fb2fee38be41315356ffe3f2460e2c0384f 100644
--- a/core/modules/node/node.services.yml
+++ b/core/modules/node/node.services.yml
@@ -39,8 +39,8 @@ services:
arguments: ['@current_route_match']
tags:
- { name: page_cache_response_policy }
- cache_context.node_view_grants:
- class: Drupal\node\Cache\NodeAccessViewGrantsCacheContext
+ cache_context.user.node_grants:
+ class: Drupal\node\Cache\NodeAccessGrantsCacheContext
arguments: ['@current_user']
tags:
- { name: cache.context }
diff --git a/core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php b/core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php
new file mode 100644
index 0000000000000000000000000000000000000000..e213c40d62b647de623fb4f395bf185928cc880f
--- /dev/null
+++ b/core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php
@@ -0,0 +1,80 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Cache\NodeAccessGrantsCacheContext.
+ */
+
+namespace Drupal\node\Cache;
+
+use Drupal\Core\Cache\CalculatedCacheContextInterface;
+use Drupal\Core\Cache\UserCacheContext;
+
+/**
+ * Defines the node access view cache context service.
+ *
+ * This allows for node access grants-sensitive caching when listing nodes.
+ *
+ * @see node_query_node_access_alter()
+ */
+class NodeAccessGrantsCacheContext extends UserCacheContext implements CalculatedCacheContextInterface {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getLabel() {
+ return t("Content access view grants");
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getContext($operation = NULL) {
+ // If the current user either can bypass node access then we don't need to
+ // determine the exact node grants for the current user.
+ if ($this->user->hasPermission('bypass node access')) {
+ return 'all';
+ }
+
+ // When no specific operation is specified, check the grants for all three
+ // possible operations.
+ if ($operation === NULL) {
+ $result = [];
+ foreach (['view', 'update', 'delete'] as $op) {
+ $result[] = $this->checkNodeGrants($op);
+ }
+ return implode('-', $result);
+ }
+ else {
+ return $this->checkNodeGrants($operation);
+ }
+ }
+
+ /**
+ * Checks the node grants for the given operation.
+ *
+ * @param string $operation
+ * The operation to check the node grants for.
+ *
+ * @return string
+ * The string representation of the cache context.
+ */
+ protected function checkNodeGrants($operation) {
+ // When checking the grants for the 'view' operation and the current user
+ // has a global view grant (i.e. a view grant for node ID 0) — note that
+ // this is automatically the case if no node access modules exist (no
+ // hook_node_grants() implementations) then we don't need to determine the
+ // exact node view grants for the current user.
+ if ($operation === 'view' && node_access_view_all_nodes($this->user)) {
+ return 'view.all';
+ }
+
+ $grants = node_access_grants($operation, $this->user);
+ $grants_context_parts = [];
+ foreach ($grants as $realm => $gids) {
+ $grants_context_parts[] = $realm . ':' . implode(',', $gids);
+ }
+ return $operation . '.' . implode(';', $grants_context_parts);
+ }
+
+}
diff --git a/core/modules/node/src/Cache/NodeAccessViewGrantsCacheContext.php b/core/modules/node/src/Cache/NodeAccessViewGrantsCacheContext.php
deleted file mode 100644
index 24323b9c42114149648246539ff530d5bca784d3..0000000000000000000000000000000000000000
--- a/core/modules/node/src/Cache/NodeAccessViewGrantsCacheContext.php
+++ /dev/null
@@ -1,69 +0,0 @@
-<?php
-
-/**
- * @file
- * Contains \Drupal\Core\Cache\NodeAccessViewGrantsCacheContext.
- */
-
-namespace Drupal\node\Cache;
-
-use Drupal\Core\Cache\CacheContextInterface;
-use Drupal\Core\Session\AccountInterface;
-
-/**
- * Defines the node access view grants cache context service.
- *
- * This allows for node access grants-sensitive caching when viewing nodes.
- *
- * @see node_query_node_access_alter()
- */
-class NodeAccessViewGrantsCacheContext implements CacheContextInterface {
-
- /**
- * The current user.
- *
- * @var \Drupal\Core\Session\AccountInterface
- */
- protected $user;
-
- /**
- * Constructs a new NodeAccessViewGrantsCacheContext service.
- *
- * @param \Drupal\Core\Session\AccountInterface $user
- * The current user.
- */
- public function __construct(AccountInterface $user) {
- $this->user = $user;
- }
-
- /**
- * {@inheritdoc}
- */
- public static function getLabel() {
- return t("Content access view grants");
- }
-
- /**
- * {@inheritdoc}
- */
- public function getContext() {
- // If the current user either:
- // - can bypass node access
- // - has a global view grant (such as a view grant for node ID 0) — note
- // that this is automatically the case if no node access modules exist (no
- // hook_node_grants() implementations)
- // then we don't need to determine the exact node view grants for the
- // current user.
- if ($this->user->hasPermission('bypass node access') || node_access_view_all_nodes($this->user)) {
- return 'all';
- }
-
- $grants = node_access_grants('view', $this->user);
- $grants_context_parts = [];
- foreach ($grants as $realm => $gids) {
- $grants_context_parts[] = $realm . ':' . implode(',', $gids);
- }
- return implode(';', $grants_context_parts);
- }
-
-}
diff --git a/core/modules/node/src/Entity/Node.php b/core/modules/node/src/Entity/Node.php
index eb99636dc4fe02fb002b267cf1f4b7398865b8a4..2621d82a2dd17268bf4aa533de823f1d20091b21 100644
--- a/core/modules/node/src/Entity/Node.php
+++ b/core/modules/node/src/Entity/Node.php
@@ -45,7 +45,7 @@
* revision_table = "node_revision",
* revision_data_table = "node_field_revision",
* translatable = TRUE,
- * list_cache_contexts = { "node_view_grants" },
+ * list_cache_contexts = { "user.node_grants:view" },
* entity_keys = {
* "id" = "nid",
* "revision" = "vid",
diff --git a/core/modules/node/src/NodeGrantDatabaseStorage.php b/core/modules/node/src/NodeGrantDatabaseStorage.php
index da6522dc0efa0a8686e23ed3f362b30a3d727f9f..5c661900468560404cb22c3bcec6149eec2aae16 100644
--- a/core/modules/node/src/NodeGrantDatabaseStorage.php
+++ b/core/modules/node/src/NodeGrantDatabaseStorage.php
@@ -106,12 +106,11 @@ public function access(NodeInterface $node, $operation, $langcode, AccountInterf
// theoretically cacheable, because we don't have the necessary metadata to
// know it for a fact.
$set_cacheability = function (AccessResult $access_result) use ($operation) {
- if ($operation === 'view') {
- return $access_result->addCacheContexts(['node_view_grants']);
- }
- else {
- return $access_result->setCacheable(FALSE);
+ $access_result->addCacheContexts(['user.node_grants:' . $operation]);
+ if ($operation !== 'view') {
+ $access_result->setCacheable(FALSE);
}
+ return $access_result;
};
if ($query->execute()->fetchField()) {
diff --git a/core/modules/node/src/Plugin/views/argument_default/Node.php b/core/modules/node/src/Plugin/views/argument_default/Node.php
index 4a61f032a2b5410fe86b250a6bab6a8f164a0455..e6d8343233c508feb86651cc9b1ab0fbb7bee451 100644
--- a/core/modules/node/src/Plugin/views/argument_default/Node.php
+++ b/core/modules/node/src/Plugin/views/argument_default/Node.php
@@ -83,7 +83,7 @@ public function isCacheable() {
* {@inheritdoc}
*/
public function getCacheContexts() {
- return ['cache.context.url'];
+ return ['url'];
}
}
diff --git a/core/modules/node/src/Tests/NodeAccessViewGrantsCacheContextTest.php b/core/modules/node/src/Tests/NodeAccessGrantsCacheContextTest.php
similarity index 76%
rename from core/modules/node/src/Tests/NodeAccessViewGrantsCacheContextTest.php
rename to core/modules/node/src/Tests/NodeAccessGrantsCacheContextTest.php
index 1cd8062dab41ca73eaaa49daccca786000a5f39c..d66e7769eb53d7d51fdd8685f8b04789b41b279c 100644
--- a/core/modules/node/src/Tests/NodeAccessViewGrantsCacheContextTest.php
+++ b/core/modules/node/src/Tests/NodeAccessGrantsCacheContextTest.php
@@ -2,18 +2,18 @@
/**
* @file
- * Contains \Drupal\node\Tests\NodeAccessViewGrantsCacheContextTest.
+ * Contains \Drupal\node\Tests\NodeAccessGrantsCacheContextTest.
*/
namespace Drupal\node\Tests;
/**
- * Tests the node access view grants cache context service.
+ * Tests the node access grants cache context service.
*
* @group node
* @group Cache
*/
-class NodeAccessViewGrantsCacheContextTest extends NodeTestBase {
+class NodeAccessGrantsCacheContextTest extends NodeTestBase {
/**
* Modules to enable.
@@ -71,20 +71,20 @@ protected function assertCacheContext(array $expected) {
$this->drupalLogin($this->userMapping[$uid]);
}
$this->pass('Asserting cache context for user ' . $uid . '.');
- $this->assertIdentical($context, $this->container->get('cache_context.node_view_grants')->getContext());
+ $this->assertIdentical($context, $this->container->get('cache_context.user.node_grants')->getContext('view'));
}
$this->drupalLogout();
}
/**
- * Tests NodeAccessViewGrantsCacheContext::getContext().
+ * Tests NodeAccessGrantsCacheContext::getContext().
*/
public function testCacheContext() {
$this->assertCacheContext([
- 0 => 'all:0;node_access_test_author:0;node_access_all:0',
+ 0 => 'view.all:0;node_access_test_author:0;node_access_all:0',
1 => 'all',
- 2 => 'all:0;node_access_test_author:2;node_access_test:8888,8889',
- 3 => 'all:0;node_access_test_author:3',
+ 2 => 'view.all:0;node_access_test_author:2;node_access_test:8888,8889',
+ 3 => 'view.all:0;node_access_test_author:3',
]);
// Grant view to all nodes (because nid = 0) for users in the
@@ -103,40 +103,40 @@ public function testCacheContext() {
\Drupal::state()->set('node_access_test.no_access_uid', 0);
drupal_static_reset('node_access_view_all_nodes');
$this->assertCacheContext([
- 0 => 'all',
+ 0 => 'view.all',
1 => 'all',
- 2 => 'all:0;node_access_test_author:2;node_access_test:8888,8889',
- 3 => 'all:0;node_access_test_author:3',
+ 2 => 'view.all:0;node_access_test_author:2;node_access_test:8888,8889',
+ 3 => 'view.all:0;node_access_test_author:3',
]);
// Put user accessUser (uid 2) in the realm.
\Drupal::state()->set('node_access_test.no_access_uid', $this->accessUser->id());
drupal_static_reset('node_access_view_all_nodes');
$this->assertCacheContext([
- 0 => 'all:0;node_access_test_author:0',
+ 0 => 'view.all:0;node_access_test_author:0',
1 => 'all',
- 2 => 'all',
- 3 => 'all:0;node_access_test_author:3',
+ 2 => 'view.all',
+ 3 => 'view.all:0;node_access_test_author:3',
]);
// Put user noAccessUser (uid 3) in the realm.
\Drupal::state()->set('node_access_test.no_access_uid', $this->noAccessUser->id());
drupal_static_reset('node_access_view_all_nodes');
$this->assertCacheContext([
- 0 => 'all:0;node_access_test_author:0',
+ 0 => 'view.all:0;node_access_test_author:0',
1 => 'all',
- 2 => 'all:0;node_access_test_author:2;node_access_test:8888,8889',
- 3 => 'all',
+ 2 => 'view.all:0;node_access_test_author:2;node_access_test:8888,8889',
+ 3 => 'view.all',
]);
// Uninstall the node_access_test module
$this->container->get('module_installer')->uninstall(['node_access_test']);
drupal_static_reset('node_access_view_all_nodes');
$this->assertCacheContext([
- 0 => 'all',
+ 0 => 'view.all',
1 => 'all',
- 2 => 'all',
- 3 => 'all',
+ 2 => 'view.all',
+ 3 => 'view.all',
]);
}
diff --git a/core/modules/node/src/Tests/NodeCacheTagsTest.php b/core/modules/node/src/Tests/NodeCacheTagsTest.php
index c18f15b3079a99cabc5282f8c649d12041abe63e..8144ba283bb7a85a5969050f52804d34a01d0e7b 100644
--- a/core/modules/node/src/Tests/NodeCacheTagsTest.php
+++ b/core/modules/node/src/Tests/NodeCacheTagsTest.php
@@ -62,7 +62,7 @@ protected function getAdditionalCacheTagsForEntity(EntityInterface $node) {
* {@inheritdoc}
*/
protected function getAdditionalCacheContextsForEntityListing() {
- return ['node_view_grants'];
+ return ['user.node_grants:view'];
}
}
diff --git a/core/modules/node/src/Tests/NodeListBuilderTest.php b/core/modules/node/src/Tests/NodeListBuilderTest.php
index a594f1f59fc98e8c8fd8b2813ace107639cd92d9..ec4b1ea89f8de9da77f4b290b6dc4f7534a4829d 100644
--- a/core/modules/node/src/Tests/NodeListBuilderTest.php
+++ b/core/modules/node/src/Tests/NodeListBuilderTest.php
@@ -38,7 +38,7 @@ public function testCacheContexts() {
$build = $list_builder->render();
$this->container->get('renderer')->render($build);
- $this->assertEqual(['node_view_grants', 'pager:0'], $build['#cache']['contexts']);
+ $this->assertEqual(['url.query_args.pagers:0', 'user.node_grants:view'], $build['#cache']['contexts']);
}
}
diff --git a/core/modules/node/src/Tests/Views/FrontPageTest.php b/core/modules/node/src/Tests/Views/FrontPageTest.php
index 61fe5eb170e95e868e60f0645ac647be002f12c2..ed6fd3ddcde9cb41409e765b722d6f9a1cc9b895 100644
--- a/core/modules/node/src/Tests/Views/FrontPageTest.php
+++ b/core/modules/node/src/Tests/Views/FrontPageTest.php
@@ -241,7 +241,7 @@ protected function assertFrontPageViewCacheTags($do_assert_views_caches) {
$view = Views::getView('frontpage');
$view->setDisplay('page_1');
- $cache_contexts = ['node_view_grants', 'language'];
+ $cache_contexts = ['user.node_grants:view', 'languages'];
// Test before there are any nodes.
$empty_node_listing_cache_tags = [
diff --git a/core/modules/system/src/Plugin/Block/SystemMenuBlock.php b/core/modules/system/src/Plugin/Block/SystemMenuBlock.php
index c07fba2480660ba3b8c08fd0b7e7e4feaeec7e82..19eb580d17338f79e004df3864f0ae3c74aac3ac 100644
--- a/core/modules/system/src/Plugin/Block/SystemMenuBlock.php
+++ b/core/modules/system/src/Plugin/Block/SystemMenuBlock.php
@@ -201,7 +201,7 @@ protected function getRequiredCacheContexts() {
$menu_name = $this->getDerivativeId();
return [
'user.roles',
- 'menu.active_trail:' . $menu_name,
+ 'route.menu_active_trails:' . $menu_name,
];
}
diff --git a/core/modules/system/src/Tests/Cache/PageCacheTagsIntegrationTest.php b/core/modules/system/src/Tests/Cache/PageCacheTagsIntegrationTest.php
index f4d30eceec39b4fe37e6d95558d7f4019a761396..8078913da528afb6d2c052513882bf96c861efc5 100644
--- a/core/modules/system/src/Tests/Cache/PageCacheTagsIntegrationTest.php
+++ b/core/modules/system/src/Tests/Cache/PageCacheTagsIntegrationTest.php
@@ -68,11 +68,11 @@ function testPageCacheTags() {
));
$cache_contexts = [
- 'language',
- 'menu.active_trail:account',
- 'menu.active_trail:footer',
- 'menu.active_trail:main',
- 'menu.active_trail:tools',
+ 'languages',
+ 'route.menu_active_trails:account',
+ 'route.menu_active_trails:footer',
+ 'route.menu_active_trails:main',
+ 'route.menu_active_trails:tools',
'theme',
'timezone',
'user.roles',
diff --git a/core/modules/system/src/Tests/Entity/EntityListBuilderTest.php b/core/modules/system/src/Tests/Entity/EntityListBuilderTest.php
index 9d8b36bd758e5be9e7c7336078ec2d57c270f2a9..fa5097a8bac4aa32fed142e75f4163680cd667e0 100644
--- a/core/modules/system/src/Tests/Entity/EntityListBuilderTest.php
+++ b/core/modules/system/src/Tests/Entity/EntityListBuilderTest.php
@@ -66,7 +66,7 @@ public function testCacheContexts() {
$build = $list_builder->render();
$this->container->get('renderer')->render($build);
- $this->assertEqual(['entity_test_view_grants', 'pager:0'], $build['#cache']['contexts']);
+ $this->assertEqual(['entity_test_view_grants', 'url.query_args.pagers:0'], $build['#cache']['contexts']);
}
}
diff --git a/core/modules/system/tests/modules/pager_test/src/Controller/PagerTestController.php b/core/modules/system/tests/modules/pager_test/src/Controller/PagerTestController.php
index b277c75dbf7a2e41e0668ac2194911567f4f4ca8..2448cce0649b63eebb399409480236eb5ab53d04 100644
--- a/core/modules/system/tests/modules/pager_test/src/Controller/PagerTestController.php
+++ b/core/modules/system/tests/modules/pager_test/src/Controller/PagerTestController.php
@@ -69,7 +69,7 @@ public function queryParameters() {
* #pre_render callback for #type => pager that shows the pager cache context.
*/
public static function showPagerCacheContext(array $pager) {
- drupal_set_message(\Drupal::service('cache_contexts')->convertTokensToKeys(['pager:' . $pager['#element']])[0]);
+ drupal_set_message(\Drupal::service('cache_contexts')->convertTokensToKeys(['url.query_args.pagers:' . $pager['#element']])[0]);
return $pager;
}
diff --git a/core/modules/taxonomy/src/Plugin/views/argument_default/Tid.php b/core/modules/taxonomy/src/Plugin/views/argument_default/Tid.php
index 5bd3f4570f07482ada1a7ab904c962effb149a31..a8751d57ab52ec13300b9425acc351fff3d7145f 100644
--- a/core/modules/taxonomy/src/Plugin/views/argument_default/Tid.php
+++ b/core/modules/taxonomy/src/Plugin/views/argument_default/Tid.php
@@ -230,7 +230,7 @@ public function isCacheable() {
* {@inheritdoc}
*/
public function getCacheContexts() {
- return ['cache.context.url'];
+ return ['url'];
}
/**
diff --git a/core/modules/user/src/Cache/UserRolesCacheContext.php b/core/modules/user/src/Cache/UserRolesCacheContext.php
deleted file mode 100644
index 0f7975de46632f0018164476035476d194bd89b7..0000000000000000000000000000000000000000
--- a/core/modules/user/src/Cache/UserRolesCacheContext.php
+++ /dev/null
@@ -1,42 +0,0 @@
-<?php
-
-/**
- * @file
- * Contains \Drupal\user\Cache\UserRolesCacheContext.
- */
-
-namespace Drupal\user\Cache;
-
-use Drupal\Core\Cache\CacheContextInterface;
-use Drupal\Core\Session\AccountInterface;
-
-/**
- * Defines the UserRolesCacheContext service, for "per role" caching.
- */
-class UserRolesCacheContext implements CacheContextInterface {
-
- /**
- * Constructs a new UserRolesCacheContext service.
- *
- * @param \Drupal\Core\Session\AccountInterface $user
- * The current user.
- */
- public function __construct(AccountInterface $user) {
- $this->user = $user;
- }
-
- /**
- * {@inheritdoc}
- */
- public static function getLabel() {
- return t("User's roles");
- }
-
- /**
- * {@inheritdoc}
- */
- public function getContext() {
- return 'r.' . implode(',', $this->user->getRoles());
- }
-
-}
diff --git a/core/modules/user/src/Plugin/views/argument_default/User.php b/core/modules/user/src/Plugin/views/argument_default/User.php
index e3d9644f35fc3b9a2caa69ecb63bb581403ad796..269be4e39584daedcffa5fc9311023df5fe7163e 100644
--- a/core/modules/user/src/Plugin/views/argument_default/User.php
+++ b/core/modules/user/src/Plugin/views/argument_default/User.php
@@ -123,7 +123,7 @@ public function isCacheable() {
* {@inheritdoc}
*/
public function getCacheContexts() {
- return ['cache.context.url'];
+ return ['url'];
}
}
diff --git a/core/modules/user/user.services.yml b/core/modules/user/user.services.yml
index 4bee86981823a50da0bb385425ac87f74b1de126..cb1b741807b3fd423bf0b8223989ac27db643399 100644
--- a/core/modules/user/user.services.yml
+++ b/core/modules/user/user.services.yml
@@ -20,16 +20,6 @@ services:
arguments: ['@session_configuration']
tags:
- { name: authentication_provider, priority: 0 }
- cache_context.user:
- class: Drupal\user\Cache\UserCacheContext
- arguments: ['@current_user']
- tags:
- - { name: cache.context}
- cache_context.user.roles:
- class: Drupal\user\Cache\UserRolesCacheContext
- arguments: ['@current_user']
- tags:
- - { name: cache.context}
user.data:
class: Drupal\user\UserData
arguments: ['@database']
diff --git a/core/modules/views/src/Entity/View.php b/core/modules/views/src/Entity/View.php
index 51ad1a662b5f5f8dca55e077b45447acd62301ef..24d1ec387100075da1539f5cea6bc87e1fd23e13 100644
--- a/core/modules/views/src/Entity/View.php
+++ b/core/modules/views/src/Entity/View.php
@@ -8,6 +8,7 @@
namespace Drupal\views\Entity;
use Drupal\Component\Utility\NestedArray;
+use Drupal\Core\Cache\Cache;
use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\views\Views;
@@ -315,10 +316,9 @@ protected function addCacheMetadata() {
$executable->setDisplay($display_id);
list($display['cache_metadata']['cacheable'], $display['cache_metadata']['contexts']) = $executable->getDisplay()->calculateCacheMetadata();
- // Always include at least the language context as there will be most
- // probable translatable strings in the view output.
- $display['cache_metadata']['contexts'][] = 'language';
- $display['cache_metadata']['contexts'] = array_unique($display['cache_metadata']['contexts']);
+ // Always include at least the 'languages' context as there will most
+ // probably be translatable strings in the view output.
+ $display['cache_metadata']['contexts'] = Cache::mergeContexts($display['cache_metadata']['contexts'], ['languages']);
}
// Restore the previous active display.
$executable->setDisplay($current_display);
diff --git a/core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php b/core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php
index 069276b4df3c41f213f6efb777d57c323e903a0d..4e5469bab77becee1f319977596832409b382a63 100644
--- a/core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php
+++ b/core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php
@@ -1208,7 +1208,7 @@ public function getCacheContexts() {
// By definition arguments depends on the URL.
// @todo Once contexts are properly injected into block views we could pull
// the information from there.
- $contexts[] = 'cache.context.url';
+ $contexts[] = 'url';
// Asks all subplugins (argument defaults, argument validator and styles).
if (($plugin = $this->getPlugin('argument_default')) && $plugin instanceof CacheablePluginInterface) {
diff --git a/core/modules/views/src/Plugin/views/argument_default/QueryParameter.php b/core/modules/views/src/Plugin/views/argument_default/QueryParameter.php
index 337b72271dddc3285d95f9917ba178e5317df398..feccd21e1d29068388d4a9103bdfcc64dafe8dab 100644
--- a/core/modules/views/src/Plugin/views/argument_default/QueryParameter.php
+++ b/core/modules/views/src/Plugin/views/argument_default/QueryParameter.php
@@ -95,7 +95,7 @@ public function isCacheable() {
* {@inheritdoc}
*/
public function getCacheContexts() {
- return ['cache.context.url'];
+ return ['url'];
}
}
diff --git a/core/modules/views/src/Plugin/views/argument_default/Raw.php b/core/modules/views/src/Plugin/views/argument_default/Raw.php
index 4239c50e2f5e5896d062f2412ae73cdbdc6833c4..40bddf3531f2f099ab02b4d9b1ab763c8ec9335d 100644
--- a/core/modules/views/src/Plugin/views/argument_default/Raw.php
+++ b/core/modules/views/src/Plugin/views/argument_default/Raw.php
@@ -124,7 +124,7 @@ public function isCacheable() {
* {@inheritdoc}
*/
public function getCacheContexts() {
- return ['cache.context.url'];
+ return ['url'];
}
}
diff --git a/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php b/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php
index b5f8bf87549703d2dbeef1bb6cd14763d8aa3a30..9abf63ed109e70c17f98f703b23af2971b11fac6 100644
--- a/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php
+++ b/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php
@@ -1477,7 +1477,7 @@ public function getCacheContexts() {
// input from GET parameters, which are part of the URL. Hence a view with
// an exposed filter is cacheable per URL.
if ($this->isExposed()) {
- $cache_contexts[] = 'cache.context.url';
+ $cache_contexts[] = 'url';
}
return $cache_contexts;
}
diff --git a/core/modules/views/src/Plugin/views/sort/SortPluginBase.php b/core/modules/views/src/Plugin/views/sort/SortPluginBase.php
index 45b86bee6b0a4ac9f4f2bbddb78f501759ae5d34..8fe2b43b5fc03f9704668f0e3b7f823c1b6c2779 100644
--- a/core/modules/views/src/Plugin/views/sort/SortPluginBase.php
+++ b/core/modules/views/src/Plugin/views/sort/SortPluginBase.php
@@ -241,7 +241,7 @@ public function getCacheContexts() {
$cache_contexts = [];
// Exposed sorts use GET parameters, so it depends on the current URL.
if ($this->isExposed()) {
- $cache_contexts[] = 'cache.context.url';
+ $cache_contexts[] = 'url';
}
return $cache_contexts;
}
diff --git a/core/modules/views/src/Tests/GlossaryTest.php b/core/modules/views/src/Tests/GlossaryTest.php
index fd979780957bcf283c45b642a6662bbd28dbfb3b..1df4701e6799a5d387fbe8538cbbee6a97138ba4 100644
--- a/core/modules/views/src/Tests/GlossaryTest.php
+++ b/core/modules/views/src/Tests/GlossaryTest.php
@@ -87,7 +87,7 @@ public function testGlossaryView() {
// Verify cache tags.
$this->enablePageCaching();
- $this->assertPageCacheContextsAndTags(Url::fromRoute('view.glossary.page_1'), ['cache.context.url', 'node_view_grants', 'language', 'user'], [
+ $this->assertPageCacheContextsAndTags(Url::fromRoute('view.glossary.page_1'), ['languages', 'url', 'user'], [
'config:views.view.glossary',
'node:' . $nodes_by_char['a'][0]->id(), 'node:' . $nodes_by_char['a'][1]->id(), 'node:' . $nodes_by_char['a'][2]->id(),
'node_list',
diff --git a/core/modules/views/src/Tests/RenderCacheIntegrationTest.php b/core/modules/views/src/Tests/RenderCacheIntegrationTest.php
index da94ab4b8ca59af7edb953fcd39e673904841d01..4a9276f17edddd65b462854a2f2eb808adf21d97 100644
--- a/core/modules/views/src/Tests/RenderCacheIntegrationTest.php
+++ b/core/modules/views/src/Tests/RenderCacheIntegrationTest.php
@@ -221,7 +221,7 @@ public function testViewAddCacheMetadata() {
$view = View::load('test_display');
$view->save();
- $this->assertEqual(['node_view_grants', 'user', 'language'], $view->getDisplay('default')['cache_metadata']['contexts']);
+ $this->assertEqual(['languages', 'user', 'user.node_grants:view'], $view->getDisplay('default')['cache_metadata']['contexts']);
}
}
diff --git a/core/tests/Drupal/Tests/Core/Cache/CacheContextsTest.php b/core/tests/Drupal/Tests/Core/Cache/CacheContextsTest.php
index 1563a6df4f4fc1cd2f157183fb65058b0f18dca4..a81f52d4e8c2d1dfc29a41a5a2fa53b43e5351cc 100644
--- a/core/tests/Drupal/Tests/Core/Cache/CacheContextsTest.php
+++ b/core/tests/Drupal/Tests/Core/Cache/CacheContextsTest.php
@@ -19,6 +19,63 @@
*/
class CacheContextsTest extends UnitTestCase {
+ /**
+ * @covers ::optimizeTokens
+ *
+ * @dataProvider providerTestOptimizeTokens
+ */
+ public function testOptimizeTokens(array $context_tokens, array $optimized_context_tokens) {
+ $container = $this->getMockBuilder('Drupal\Core\DependencyInjection\Container')
+ ->disableOriginalConstructor()
+ ->getMock();
+ $container->expects($this->any())
+ ->method('get')
+ ->will($this->returnValueMap([
+ ['a', Container::EXCEPTION_ON_INVALID_REFERENCE, new FooCacheContext()],
+ ['a.b', Container::EXCEPTION_ON_INVALID_REFERENCE, new FooCacheContext()],
+ ['a.b.c', Container::EXCEPTION_ON_INVALID_REFERENCE, new BazCacheContext()],
+ ['x', Container::EXCEPTION_ON_INVALID_REFERENCE, new BazCacheContext()],
+ ]));
+ $cache_contexts = new CacheContexts($container, $this->getContextsFixture());
+
+ $this->assertSame($optimized_context_tokens, $cache_contexts->optimizeTokens($context_tokens));
+ }
+
+ /**
+ * Provides a list of context token sets.
+ */
+ public function providerTestOptimizeTokens() {
+ return [
+ [['a', 'x'], ['a', 'x']],
+ [['a.b', 'x'], ['a.b', 'x']],
+
+ // Direct ancestor, single-level hierarchy.
+ [['a', 'a.b'], ['a']],
+ [['a.b', 'a'], ['a']],
+
+ // Direct ancestor, multi-level hierarchy.
+ [['a.b', 'a.b.c'], ['a.b']],
+ [['a.b.c', 'a.b'], ['a.b']],
+
+ // Indirect ancestor.
+ [['a', 'a.b.c'], ['a']],
+ [['a.b.c', 'a'], ['a']],
+
+ // Direct & indirect ancestors.
+ [['a', 'a.b', 'a.b.c'], ['a']],
+ [['a', 'a.b.c', 'a.b'], ['a']],
+ [['a.b', 'a', 'a.b.c'], ['a']],
+ [['a.b', 'a.b.c', 'a'], ['a']],
+ [['a.b.c', 'a.b', 'a'], ['a']],
+ [['a.b.c', 'a', 'a.b'], ['a']],
+
+ // Using parameters.
+ [['a', 'a.b.c:foo'], ['a']],
+ [['a.b.c:foo', 'a'], ['a']],
+ [['a.b.c:foo', 'a.b.c'], ['a.b.c']],
+ ];
+ }
+
/**
* @covers ::convertTokensToKeys
*/
@@ -146,7 +203,7 @@ public static function getLabel() {
/**
* {@inheritdoc}
*/
- public function getContext($parameter) {
+ public function getContext($parameter = NULL) {
if (!is_string($parameter) || strlen($parameter) === 0) {
throw new \Exception();
}