diff --git a/core/authorize.php b/core/authorize.php index fe374fa..1138c92 100644 --- a/core/authorize.php +++ b/core/authorize.php @@ -120,31 +120,15 @@ function authorize_access_allowed(Request $request) { '#messages' => $results['messages'], ); + $links = array(); if (is_array($results['tasks'])) { - $links = $results['tasks']; + $links += $results['tasks']; } else { - // Since this is being called outsite of the primary front controller, - // the base_url needs to be set explicitly to ensure that links are - // relative to the site root. - // @todo Simplify with https://www.drupal.org/node/2548095 - $default_options = [ - '#type' => 'link', - '#options' => [ - 'absolute' => TRUE, - 'base_url' => $GLOBALS['base_url'], - ], - ]; - $links = [ - $default_options + [ - '#url' => Url::fromRoute('system.admin'), - '#title' => t('Administration pages'), - ], - $default_options + [ - '#url' => Url::fromRoute(''), - '#title' => t('Front page'), - ], - ]; + $links = array_merge($links, array( + \Drupal::l(t('Administration pages'), new Url('system.admin')), + \Drupal::l(t('Front page'), new Url('')), + )); } $content['next_steps'] = array( diff --git a/core/composer.json b/core/composer.json index b1547df..26938e3 100644 --- a/core/composer.json +++ b/core/composer.json @@ -18,7 +18,7 @@ "symfony/validator": "2.7.*", "symfony/process": "2.7.*", "symfony/yaml": "2.7.*", - "twig/twig": "1.20.*", + "twig/twig": "1.18.*", "doctrine/common": "~2.4.2", "doctrine/annotations": "1.2.*", "guzzlehttp/guzzle": "dev-master#1879fbe853b0c64d109e369c7aeff09849e62d1e", diff --git a/core/composer.lock b/core/composer.lock index c121990..676d0bf 100644 --- a/core/composer.lock +++ b/core/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], - "hash": "6d065bd806544df5f446905bc3d6379f", + "hash": "3708d8fdb54957e5ce661cda1df88353", "packages": [ { "name": "behat/mink", @@ -796,7 +796,7 @@ }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/guzzle/guzzle/zipball/e4046d42e6abc055c16d47bfbae573ae4c8646d1", + "url": "https://api.github.com/repos/guzzle/guzzle/zipball/1879fbe853b0c64d109e369c7aeff09849e62d1e", "reference": "1879fbe853b0c64d109e369c7aeff09849e62d1e", "shasum": "" }, @@ -3111,16 +3111,16 @@ }, { "name": "twig/twig", - "version": "v1.20.0", + "version": "v1.18.1", "source": { "type": "git", "url": "https://github.com/twigphp/Twig.git", - "reference": "1ea4e5f81c6d005fe84d0b38e1c4f1955eb86844" + "reference": "9f70492f44398e276d1b81c1b43adfe6751c7b7f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/twigphp/Twig/zipball/1ea4e5f81c6d005fe84d0b38e1c4f1955eb86844", - "reference": "1ea4e5f81c6d005fe84d0b38e1c4f1955eb86844", + "url": "https://api.github.com/repos/twigphp/Twig/zipball/9f70492f44398e276d1b81c1b43adfe6751c7b7f", + "reference": "9f70492f44398e276d1b81c1b43adfe6751c7b7f", "shasum": "" }, "require": { @@ -3129,7 +3129,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.20-dev" + "dev-master": "1.18-dev" } }, "autoload": { @@ -3164,7 +3164,7 @@ "keywords": [ "templating" ], - "time": "2015-08-12 15:56:39" + "time": "2015-04-19 08:30:27" }, { "name": "zendframework/zend-diactoros", diff --git a/core/core.services.yml b/core/core.services.yml index 9d40627..5ba0116 100644 --- a/core/core.services.yml +++ b/core/core.services.yml @@ -62,11 +62,6 @@ services: arguments: ['@request_stack'] tags: - { name: cache.context } - cache_context.url.path: - class: Drupal\Core\Cache\Context\PathCacheContext - arguments: ['@request_stack'] - tags: - - { name: cache.context } cache_context.url.query_args: class: Drupal\Core\Cache\Context\QueryArgsCacheContext arguments: ['@request_stack'] diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index 03572a6..a8b4057 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -279,6 +279,70 @@ function drupal_get_path($type, $name) { } /** + * Sets an HTTP response header for the current page. + * + * Note: When sending a Content-Type header, always include a 'charset' type, + * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS). + * + * @param $name + * The HTTP header name, or the special 'Status' header name. + * @param $value + * The HTTP header value; if equal to FALSE, the specified header is unset. + * If $name is 'Status', this is expected to be a status code followed by a + * reason phrase, e.g. "404 Not Found". + * @param $append + * Whether to append the value to an existing header or to replace it. + * + * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0. + * Use \Symfony\Component\HttpFoundation\Response->headers->set(). + * See https://www.drupal.org/node/2181523. + */ +function _drupal_add_http_header($name, $value, $append = FALSE) { + // The headers as name/value pairs. + $headers = &drupal_static('drupal_http_headers', array()); + + $name_lower = strtolower($name); + + if ($value === FALSE) { + $headers[$name_lower] = FALSE; + } + elseif (isset($headers[$name_lower]) && $append) { + // Multiple headers with identical names may be combined using comma (RFC + // 2616, section 4.2). + $headers[$name_lower] .= ',' . $value; + } + else { + $headers[$name_lower] = $value; + } +} + +/** + * Gets the HTTP response headers for the current page. + * + * @param $name + * An HTTP header name. If omitted, all headers are returned as name/value + * pairs. If an array value is FALSE, the header has been unset. + * + * @return + * A string containing the header value, or FALSE if the header has been set, + * or NULL if the header has not been set. + * + * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0. + * Use \Symfony\Component\HttpFoundation\Response->headers->get(). + * See https://www.drupal.org/node/2181523. + */ +function drupal_get_http_header($name = NULL) { + $headers = &drupal_static('drupal_http_headers', array()); + if (isset($name)) { + $name = strtolower($name); + return isset($headers[$name]) ? $headers[$name] : NULL; + } + else { + return $headers; + } +} + +/** * Translates a string to the current language or to a given language. * * The t() function serves two purposes. First, at run-time it translates diff --git a/core/includes/common.inc b/core/includes/common.inc index 006c58f..7d33f07 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -643,7 +643,7 @@ function drupal_process_attached(array $elements) { call_user_func_array('_drupal_add_html_head_link', $args); break; case 'http_header': - // @todo Remove validation in https://www.drupal.org/node/2477223 + call_user_func_array('_drupal_add_http_header', $args); break; default: throw new \LogicException(sprintf('You are not allowed to use %s in #attached', $callback)); diff --git a/core/includes/theme.inc b/core/includes/theme.inc index 009bb33..2595dd0 100644 --- a/core/includes/theme.inc +++ b/core/includes/theme.inc @@ -1746,10 +1746,17 @@ function drupal_common_theme() { 'maintenance_task_list' => array( 'variables' => array('items' => NULL, 'active' => NULL, 'variant' => NULL), ), + 'authorize_message' => array( + 'variables' => array('message' => NULL, 'success' => TRUE), + 'function' => 'theme_authorize_message', + 'path' => 'core/includes', + 'file' => 'theme.maintenance.inc', + ), 'authorize_report' => array( - 'variables' => ['messages' => [], 'attributes' => []], - 'includes' => ['core/includes/theme.maintenance.inc'], - 'template' => 'authorize-report', + 'variables' => array('messages' => array()), + 'function' => 'theme_authorize_report', + 'path' => 'core/includes', + 'file' => 'theme.maintenance.inc', ), // From pager.inc. 'pager' => array( diff --git a/core/includes/theme.maintenance.inc b/core/includes/theme.maintenance.inc index b98d28a..d23addb 100644 --- a/core/includes/theme.maintenance.inc +++ b/core/includes/theme.maintenance.inc @@ -100,37 +100,60 @@ function _drupal_maintenance_theme() { } /** - * Prepares variables for authorize.php operation report templates. + * Returns HTML for a results report of an operation run by authorize.php. * - * This report displays the results of an operation run via authorize.php. - * - * Default template: authorize-report.html.twig. - * - * @param array $variables + * @param $variables * An associative array containing: * - messages: An array of result messages. + * + * @ingroup themeable */ -function template_preprocess_authorize_report(&$variables) { - $messages = []; - if (!empty($variables['messages'])) { - foreach ($variables['messages'] as $heading => $logs) { - $items = []; +function theme_authorize_report($variables) { + $messages = $variables['messages']; + $output = ''; + if (!empty($messages)) { + $output .= '
'; + foreach ($messages as $heading => $logs) { + $items = array(); foreach ($logs as $number => $log_message) { if ($number === '#abort') { continue; } - $class = 'authorize-results__' . ($log_message['success'] ? 'success' : 'failure'); - $items[] = [ - '#wrapper_attributes' => ['class' => [$class]], - '#markup' => $log_message['message'], - ]; + $authorize_message = array( + '#theme' => 'authorize_message', + '#message' => $log_message['message'], + '#success' => $log_message['success'], + ); + $items[] = array( + '#markup' => drupal_render($authorize_message), + '#wrapper_attributes' => array('class' => $log_message['success'] ? 'authorize-results__success' : 'authorize-results__failure'), + ); } - $messages[] = [ + $item_list = array( '#theme' => 'item_list', '#items' => $items, '#title' => $heading, - ]; + ); + $output .= drupal_render($item_list); } + $output .= '
'; } - $variables['messages'] = $messages; + return $output; +} + +/** + * Returns HTML for a single log message from the authorize.php batch operation. + * + * @param $variables + * An associative array containing: + * - message: The log message. + * It's the caller's responsibility to ensure this string contains no + * dangerous HTML such as SCRIPT tags. + * - success: A boolean indicating failure or success. + * + * @ingroup themeable + */ +function theme_authorize_message($variables) { + $item = array('#markup' => $variables['message']); + return drupal_render($item); } diff --git a/core/lib/Drupal/Component/Utility/SafeStringInterface.php b/core/lib/Drupal/Component/Utility/SafeStringInterface.php index 136dd37..3729027 100644 --- a/core/lib/Drupal/Component/Utility/SafeStringInterface.php +++ b/core/lib/Drupal/Component/Utility/SafeStringInterface.php @@ -10,25 +10,15 @@ /** * Marks an object's __toString() method as returning safe markup. * - * All objects that implement this interface should be marked @internal. - * * This interface should only be used on objects that emit known safe strings * from their __toString() method. If there is any risk of the method returning * user-entered data that has not been filtered first, it must not be used. * - * If the object is going to be used directly in Twig templates it should - * implement \Countable so it can be used in if statements. - * * @internal * This interface is marked as internal because it should only be used by - * objects used during rendering. This interface should be used by modules if - * they interrupt the render pipeline and explicitly deal with SafeString - * objects created by the render system. Additionally, if a module reuses the - * regular render pipeline internally and passes processed data into it. For - * example, Views implements a custom render pipeline in order to render JSON - * and to fast render fields. + * objects used during rendering. Currently, there is no use case for this + * interface in contrib or custom code. * - * @see \Drupal\Component\Utility\SafeStringTrait * @see \Drupal\Component\Utility\SafeMarkup::set() * @see \Drupal\Component\Utility\SafeMarkup::isSafe() * @see \Drupal\Core\Template\TwigExtension::escapeFilter() diff --git a/core/lib/Drupal/Component/Utility/SafeStringTrait.php b/core/lib/Drupal/Component/Utility/SafeStringTrait.php deleted file mode 100644 index a91e44b..0000000 --- a/core/lib/Drupal/Component/Utility/SafeStringTrait.php +++ /dev/null @@ -1,70 +0,0 @@ -string = $string; - return $safe_string; - } - - /** - * Returns the string version of the SafeString object. - * - * @return string - * The safe string content. - */ - public function __toString() { - return $this->string; - } - - /** - * Returns the string length. - * - * @return int - * The length of the string. - */ - public function count() { - return Unicode::strlen($this->string); - } - -} diff --git a/core/lib/Drupal/Core/Access/AccessResult.php b/core/lib/Drupal/Core/Access/AccessResult.php index de15945..b364baf 100644 --- a/core/lib/Drupal/Core/Access/AccessResult.php +++ b/core/lib/Drupal/Core/Access/AccessResult.php @@ -8,8 +8,6 @@ use Drupal\Core\Cache\Cache; use Drupal\Core\Cache\CacheableDependencyInterface; -use Drupal\Core\Cache\RefinableCacheableDependencyInterface; -use Drupal\Core\Cache\RefinableCacheableDependencyTrait; use Drupal\Core\Config\ConfigBase; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Session\AccountInterface; @@ -27,10 +25,47 @@ * * When using ::orIf() and ::andIf(), cacheability metadata will be merged * accordingly as well. + * + * @todo Use RefinableCacheableDependencyInterface and the corresponding trait in + * https://www.drupal.org/node/2526326. */ -abstract class AccessResult implements AccessResultInterface, RefinableCacheableDependencyInterface { +abstract class AccessResult implements AccessResultInterface, CacheableDependencyInterface { + + /** + * The cache context IDs (to vary a cache item ID based on active contexts). + * + * @see \Drupal\Core\Cache\Context\CacheContextInterface + * @see \Drupal\Core\Cache\Context\CacheContextsManager::convertTokensToKeys() + * + * @var string[] + */ + protected $contexts; + + /** + * The cache tags. + * + * @var array + */ + protected $tags; + + /** + * The maximum caching time in seconds. + * + * @var int + */ + protected $maxAge; - use RefinableCacheableDependencyTrait; + /** + * Constructs a new AccessResult object. + */ + public function __construct() { + $this->resetCacheContexts() + ->resetCacheTags() + // Max-age must be non-zero for an access result to be cacheable. + // Typically, cache items are invalidated via associated cache tags, not + // via a maximum age. + ->setCacheMaxAge(Cache::PERMANENT); + } /** * Creates an AccessResultInterface object with isNeutral() === TRUE. @@ -180,21 +215,35 @@ public function isNeutral() { * {@inheritdoc} */ public function getCacheContexts() { - return $this->cacheContexts; + sort($this->contexts); + return $this->contexts; } /** * {@inheritdoc} */ public function getCacheTags() { - return $this->cacheTags; + return $this->tags; } /** * {@inheritdoc} */ public function getCacheMaxAge() { - return $this->cacheMaxAge; + return $this->maxAge; + } + + /** + * Adds cache contexts associated with the access result. + * + * @param string[] $contexts + * An array of cache context IDs, used to generate a cache ID. + * + * @return $this + */ + public function addCacheContexts(array $contexts) { + $this->contexts = array_unique(array_merge($this->contexts, $contexts)); + return $this; } /** @@ -203,7 +252,20 @@ public function getCacheMaxAge() { * @return $this */ public function resetCacheContexts() { - $this->cacheContexts = []; + $this->contexts = array(); + return $this; + } + + /** + * Adds cache tags associated with the access result. + * + * @param array $tags + * An array of cache tags. + * + * @return $this + */ + public function addCacheTags(array $tags) { + $this->tags = Cache::mergeTags($this->tags, $tags); return $this; } @@ -213,7 +275,7 @@ public function resetCacheContexts() { * @return $this */ public function resetCacheTags() { - $this->cacheTags = []; + $this->tags = array(); return $this; } @@ -226,7 +288,7 @@ public function resetCacheTags() { * @return $this */ public function setCacheMaxAge($max_age) { - $this->cacheMaxAge = $max_age; + $this->maxAge = $max_age; return $this; } @@ -281,6 +343,28 @@ public function cacheUntilConfigurationChanges(ConfigBase $configuration) { } /** + * Adds a dependency on an object: merges its cacheability metadata. + * + * @param \Drupal\Core\Cache\CacheableDependencyInterface|object $other_object + * The dependency. If the object implements CacheableDependencyInterface, + * then its cacheability metadata will be used. Otherwise, the passed in + * object must be assumed to be uncacheable, so max-age 0 is set. + * + * @return $this + */ + public function addCacheableDependency($other_object) { + if ($other_object instanceof CacheableDependencyInterface) { + $this->contexts = Cache::mergeContexts($this->contexts, $other_object->getCacheContexts()); + $this->tags = Cache::mergeTags($this->tags, $other_object->getCacheTags()); + $this->maxAge = Cache::mergeMaxAges($this->maxAge, $other_object->getCacheMaxAge()); + } + else { + $this->maxAge = 0; + } + return $this; + } + + /** * {@inheritdoc} */ public function orIf(AccessResultInterface $other) { @@ -368,19 +452,12 @@ public function andIf(AccessResultInterface $other) { /** * Inherits the cacheability of the other access result, if any. * - * inheritCacheability() differs from addCacheableDependency() in how it - * handles max-age, because it is designed to inherit the cacheability of the - * second operand in the andIf() and orIf() operations. There, the situation - * "allowed, max-age=0 OR allowed, max-age=1000" needs to yield max-age 1000 - * as the end result. - * * @param \Drupal\Core\Access\AccessResultInterface $other * The other access result, whose cacheability (if any) to inherit. * * @return $this */ public function inheritCacheability(AccessResultInterface $other) { - $this->addCacheableDependency($other); if ($other instanceof CacheableDependencyInterface) { if ($this->getCacheMaxAge() !== 0 && $other->getCacheMaxAge() !== 0) { $this->setCacheMaxAge(Cache::mergeMaxAges($this->getCacheMaxAge(), $other->getCacheMaxAge())); @@ -388,6 +465,14 @@ public function inheritCacheability(AccessResultInterface $other) { else { $this->setCacheMaxAge($other->getCacheMaxAge()); } + $this->addCacheContexts($other->getCacheContexts()); + $this->addCacheTags($other->getCacheTags()); + } + // If any of the access results don't provide cacheability metadata, then + // we cannot cache the combined access result, for we may not make + // assumptions. + else { + $this->setCacheMaxAge(0); } return $this; } diff --git a/core/lib/Drupal/Core/Breadcrumb/Breadcrumb.php b/core/lib/Drupal/Core/Breadcrumb/Breadcrumb.php deleted file mode 100644 index 1418807..0000000 --- a/core/lib/Drupal/Core/Breadcrumb/Breadcrumb.php +++ /dev/null @@ -1,71 +0,0 @@ -links; - } - - /** - * Sets the breadcrumb links. - * - * @param \Drupal\Core\Link[] $links - * The breadcrumb links. - * - * @return $this - * - * @throws \LogicException - * Thrown when setting breadcrumb links after they've already been set. - */ - public function setLinks(array $links) { - if (!empty($this->links)) { - throw new \LogicException('Once breadcrumb links are set, only additional breadcrumb links can be added.'); - } - - $this->links = $links; - - return $this; - } - - /** - * Appends a link to the end of the ordered list of breadcrumb links. - * - * @param \Drupal\Core\Link $link - * The link appended to the breadcrumb. - * - * @return $this - */ - public function addLink(Link $link) { - $this->links[] = $link; - - return $this; - } - -} diff --git a/core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php b/core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php index e566f54..ebdfa55 100644 --- a/core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php +++ b/core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php @@ -32,8 +32,9 @@ public function applies(RouteMatchInterface $route_match); * @param \Drupal\Core\Routing\RouteMatchInterface $route_match * The current route match. * - * @return \Drupal\Core\Breadcrumb\Breadcrumb - * A breadcrumb. + * @return \Drupal\Core\Link[] + * An array of links for the breadcrumb. Returning an empty array will + * suppress all breadcrumbs. */ public function build(RouteMatchInterface $route_match); diff --git a/core/lib/Drupal/Core/Breadcrumb/BreadcrumbManager.php b/core/lib/Drupal/Core/Breadcrumb/BreadcrumbManager.php index 3742363..0015bf3 100644 --- a/core/lib/Drupal/Core/Breadcrumb/BreadcrumbManager.php +++ b/core/lib/Drupal/Core/Breadcrumb/BreadcrumbManager.php @@ -75,7 +75,7 @@ public function applies(RouteMatchInterface $route_match) { * {@inheritdoc} */ public function build(RouteMatchInterface $route_match) { - $breadcrumb = new Breadcrumb(); + $breadcrumb = array(); $context = array('builder' => NULL); // Call the build method of registered breadcrumb builders, // until one of them returns an array. @@ -85,9 +85,11 @@ public function build(RouteMatchInterface $route_match) { continue; } - $breadcrumb = $builder->build($route_match); + $build = $builder->build($route_match); - if ($breadcrumb instanceof Breadcrumb) { + if (is_array($build)) { + // The builder returned an array of breadcrumb links. + $breadcrumb = $build; $context['builder'] = $builder; break; } @@ -97,7 +99,7 @@ public function build(RouteMatchInterface $route_match) { } // Allow modules to alter the breadcrumb. $this->moduleHandler->alter('system_breadcrumb', $breadcrumb, $route_match, $context); - + // Fall back to an empty breadcrumb. return $breadcrumb; } diff --git a/core/lib/Drupal/Core/Cache/CacheableMetadata.php b/core/lib/Drupal/Core/Cache/CacheableMetadata.php index 33429bf..33d5afb 100644 --- a/core/lib/Drupal/Core/Cache/CacheableMetadata.php +++ b/core/lib/Drupal/Core/Cache/CacheableMetadata.php @@ -11,16 +11,50 @@ * * @ingroup cache * + * @todo Use RefinableCacheableDependencyInterface and the corresponding trait in + * https://www.drupal.org/node/2526326. */ -class CacheableMetadata implements RefinableCacheableDependencyInterface { +class CacheableMetadata implements CacheableDependencyInterface { - use RefinableCacheableDependencyTrait; + /** + * Cache contexts. + * + * @var string[] + */ + protected $contexts = []; + + /** + * Cache tags. + * + * @var string[] + */ + protected $tags = []; + + /** + * Cache max-age. + * + * @var int + */ + protected $maxAge = Cache::PERMANENT; /** * {@inheritdoc} */ public function getCacheTags() { - return $this->cacheTags; + return $this->tags; + } + + /** + * Adds cache tags. + * + * @param string[] $cache_tags + * The cache tags to be added. + * + * @return $this + */ + public function addCacheTags(array $cache_tags) { + $this->tags = Cache::mergeTags($this->tags, $cache_tags); + return $this; } /** @@ -32,7 +66,7 @@ public function getCacheTags() { * @return $this */ public function setCacheTags(array $cache_tags) { - $this->cacheTags = $cache_tags; + $this->tags = $cache_tags; return $this; } @@ -40,7 +74,20 @@ public function setCacheTags(array $cache_tags) { * {@inheritdoc} */ public function getCacheContexts() { - return $this->cacheContexts; + return $this->contexts; + } + + /** + * Adds cache contexts. + * + * @param string[] $cache_contexts + * The cache contexts to be added. + * + * @return $this + */ + public function addCacheContexts(array $cache_contexts) { + $this->contexts = Cache::mergeContexts($this->contexts, $cache_contexts); + return $this; } /** @@ -52,7 +99,7 @@ public function getCacheContexts() { * @return $this */ public function setCacheContexts(array $cache_contexts) { - $this->cacheContexts = $cache_contexts; + $this->contexts = $cache_contexts; return $this; } @@ -60,7 +107,7 @@ public function setCacheContexts(array $cache_contexts) { * {@inheritdoc} */ public function getCacheMaxAge() { - return $this->cacheMaxAge; + return $this->maxAge; } /** @@ -81,7 +128,36 @@ public function setCacheMaxAge($max_age) { throw new \InvalidArgumentException('$max_age must be an integer'); } - $this->cacheMaxAge = $max_age; + $this->maxAge = $max_age; + return $this; + } + + /** + * Adds a dependency on an object: merges its cacheability metadata. + * + * @param \Drupal\Core\Cache\CacheableDependencyInterface|mixed $other_object + * The dependency. If the object implements CacheableDependencyInterface, + * then its cacheability metadata will be used. Otherwise, the passed in + * object must be assumed to be uncacheable, so max-age 0 is set. + * + * @return $this + */ + public function addCacheableDependency($other_object) { + if ($other_object instanceof CacheableDependencyInterface) { + $this->addCacheTags($other_object->getCacheTags()); + $this->addCacheContexts($other_object->getCacheContexts()); + if ($this->maxAge === Cache::PERMANENT) { + $this->maxAge = $other_object->getCacheMaxAge(); + } + elseif (($max_age = $other_object->getCacheMaxAge()) && $max_age !== Cache::PERMANENT) { + $this->maxAge = Cache::mergeMaxAges($this->maxAge, $max_age); + } + } + else { + // Not a cacheable dependency, this can not be cached. + $this->maxAge = 0; + } + return $this; } @@ -99,34 +175,34 @@ public function merge(CacheableMetadata $other) { // This is called many times per request, so avoid merging unless absolutely // necessary. - if (empty($this->cacheContexts)) { - $result->cacheContexts = $other->cacheContexts; + if (empty($this->contexts)) { + $result->contexts = $other->contexts; } - elseif (empty($other->cacheContexts)) { - $result->cacheContexts = $this->cacheContexts; + elseif (empty($other->contexts)) { + $result->contexts = $this->contexts; } else { - $result->cacheContexts = Cache::mergeContexts($this->cacheContexts, $other->cacheContexts); + $result->contexts = Cache::mergeContexts($this->contexts, $other->contexts); } - if (empty($this->cacheTags)) { - $result->cacheTags = $other->cacheTags; + if (empty($this->tags)) { + $result->tags = $other->tags; } - elseif (empty($other->cacheTags)) { - $result->cacheTags = $this->cacheTags; + elseif (empty($other->tags)) { + $result->tags = $this->tags; } else { - $result->cacheTags = Cache::mergeTags($this->cacheTags, $other->cacheTags); + $result->tags = Cache::mergeTags($this->tags, $other->tags); } - if ($this->cacheMaxAge === Cache::PERMANENT) { - $result->cacheMaxAge = $other->cacheMaxAge; + if ($this->maxAge === Cache::PERMANENT) { + $result->maxAge = $other->maxAge; } - elseif ($other->cacheMaxAge === Cache::PERMANENT) { - $result->cacheMaxAge = $this->cacheMaxAge; + elseif ($other->maxAge === Cache::PERMANENT) { + $result->maxAge = $this->maxAge; } else { - $result->cacheMaxAge = Cache::mergeMaxAges($this->cacheMaxAge, $other->cacheMaxAge); + $result->maxAge = Cache::mergeMaxAges($this->maxAge, $other->maxAge); } return $result; } @@ -138,9 +214,9 @@ public function merge(CacheableMetadata $other) { * A render array. */ public function applyTo(array &$build) { - $build['#cache']['contexts'] = $this->cacheContexts; - $build['#cache']['tags'] = $this->cacheTags; - $build['#cache']['max-age'] = $this->cacheMaxAge; + $build['#cache']['contexts'] = $this->contexts; + $build['#cache']['tags'] = $this->tags; + $build['#cache']['max-age'] = $this->maxAge; } /** @@ -153,9 +229,9 @@ public function applyTo(array &$build) { */ public static function createFromRenderArray(array $build) { $meta = new static(); - $meta->cacheContexts = (isset($build['#cache']['contexts'])) ? $build['#cache']['contexts'] : []; - $meta->cacheTags = (isset($build['#cache']['tags'])) ? $build['#cache']['tags'] : []; - $meta->cacheMaxAge = (isset($build['#cache']['max-age'])) ? $build['#cache']['max-age'] : Cache::PERMANENT; + $meta->contexts = (isset($build['#cache']['contexts'])) ? $build['#cache']['contexts'] : []; + $meta->tags = (isset($build['#cache']['tags'])) ? $build['#cache']['tags'] : []; + $meta->maxAge = (isset($build['#cache']['max-age'])) ? $build['#cache']['max-age'] : Cache::PERMANENT; return $meta; } @@ -173,16 +249,16 @@ public static function createFromRenderArray(array $build) { public static function createFromObject($object) { if ($object instanceof CacheableDependencyInterface) { $meta = new static(); - $meta->cacheContexts = $object->getCacheContexts(); - $meta->cacheTags = $object->getCacheTags(); - $meta->cacheMaxAge = $object->getCacheMaxAge(); + $meta->contexts = $object->getCacheContexts(); + $meta->tags = $object->getCacheTags(); + $meta->maxAge = $object->getCacheMaxAge(); return $meta; } // Objects that don't implement CacheableDependencyInterface must be assumed // to be uncacheable, so set max-age 0. $meta = new static(); - $meta->cacheMaxAge = 0; + $meta->maxAge = 0; return $meta; } diff --git a/core/lib/Drupal/Core/Cache/Context/PathCacheContext.php b/core/lib/Drupal/Core/Cache/Context/PathCacheContext.php deleted file mode 100644 index 64a221a..0000000 --- a/core/lib/Drupal/Core/Cache/Context/PathCacheContext.php +++ /dev/null @@ -1,46 +0,0 @@ -requestStack->getCurrentRequest(); - return $request->getBasePath() . $request->getPathInfo(); - } - - /** - * {@inheritdoc} - */ - public function getCacheableMetadata() { - return new CacheableMetadata(); - } - -} diff --git a/core/lib/Drupal/Core/Cache/DatabaseBackend.php b/core/lib/Drupal/Core/Cache/DatabaseBackend.php index 06c5dc2..49e830b 100644 --- a/core/lib/Drupal/Core/Cache/DatabaseBackend.php +++ b/core/lib/Drupal/Core/Cache/DatabaseBackend.php @@ -147,26 +147,17 @@ protected function prepareItem($cache, $allow_invalid) { } /** - * {@inheritdoc} + * Implements Drupal\Core\Cache\CacheBackendInterface::set(). */ public function set($cid, $data, $expire = Cache::PERMANENT, array $tags = array()) { - $this->setMultiple([ - $cid => [ - 'data' => $data, - 'expire' => $expire, - 'tags' => $tags, - ], - ]); - } - - /** - * {@inheritdoc} - */ - public function setMultiple(array $items) { + Cache::validateTags($tags); + $tags = array_unique($tags); + // Sort the cache tags so that they are stored consistently in the database. + sort($tags); $try_again = FALSE; try { // The bin might not yet exist. - $this->doSetMultiple($items); + $this->doSet($cid, $data, $expire, $tags); } catch (\Exception $e) { // If there was an exception, try to create the bins. @@ -178,19 +169,39 @@ public function setMultiple(array $items) { } // Now that the bin has been created, try again if necessary. if ($try_again) { - $this->doSetMultiple($items); + $this->doSet($cid, $data, $expire, $tags); } } /** - * Stores multiple items in the persistent cache. - * - * @param array $items - * An array of cache items, keyed by cid. - * - * @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple() + * Actually set the cache. */ - protected function doSetMultiple(array $items) { + protected function doSet($cid, $data, $expire, $tags) { + $fields = array( + 'created' => round(microtime(TRUE), 3), + 'expire' => $expire, + 'tags' => implode(' ', $tags), + 'checksum' => $this->checksumProvider->getCurrentChecksum($tags), + ); + if (!is_string($data)) { + $fields['data'] = serialize($data); + $fields['serialized'] = 1; + } + else { + $fields['data'] = $data; + $fields['serialized'] = 0; + } + + $this->connection->merge($this->bin) + ->key('cid', $this->normalizeCid($cid)) + ->fields($fields) + ->execute(); + } + + /** + * {@inheritdoc} + */ + public function setMultiple(array $items) { $values = array(); foreach ($items as $cid => $item) { @@ -205,7 +216,7 @@ protected function doSetMultiple(array $items) { sort($item['tags']); $fields = array( - 'cid' => $this->normalizeCid($cid), + 'cid' => $cid, 'expire' => $item['expire'], 'created' => round(microtime(TRUE), 3), 'tags' => implode(' ', $item['tags']), @@ -223,20 +234,34 @@ protected function doSetMultiple(array $items) { $values[] = $fields; } - // Use an upsert query which is atomic and optimized for multiple-row - // merges. - $query = $this->connection - ->upsert($this->bin) - ->key('cid') - ->fields(array('cid', 'expire', 'created', 'tags', 'checksum', 'data', 'serialized')); - foreach ($values as $fields) { - // Only pass the values since the order of $fields matches the order of - // the insert fields. This is a performance optimization to avoid - // unnecessary loops within the method. - $query->values(array_values($fields)); - } + // Use a transaction so that the database can write the changes in a single + // commit. The transaction is started after calculating the tag checksums + // since that can create a table and this causes an exception when using + // PostgreSQL. + $transaction = $this->connection->startTransaction(); - $query->execute(); + try { + // Delete all items first so we can do one insert. Rather than multiple + // merge queries. + $this->deleteMultiple(array_keys($items)); + + $query = $this->connection + ->insert($this->bin) + ->fields(array('cid', 'expire', 'created', 'tags', 'checksum', 'data', 'serialized')); + foreach ($values as $fields) { + // Only pass the values since the order of $fields matches the order of + // the insert fields. This is a performance optimization to avoid + // unnecessary loops within the method. + $query->values(array_values($fields)); + } + + $query->execute(); + } + catch (\Exception $e) { + $transaction->rollback(); + // @todo Log something here or just re throw? + throw $e; + } } /** diff --git a/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php b/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php index b94d7f3..63b1d3d 100644 --- a/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php +++ b/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php @@ -44,7 +44,7 @@ public function addCacheableDependency($other_object) { } else { // Not a cacheable dependency, this can not be cached. - $this->cacheMaxAge = 0; + $this->maxAge = 0; } return $this; } @@ -53,9 +53,7 @@ public function addCacheableDependency($other_object) { * {@inheritdoc} */ public function addCacheContexts(array $cache_contexts) { - if ($cache_contexts) { - $this->cacheContexts = Cache::mergeContexts($this->cacheContexts, $cache_contexts); - } + $this->cacheContexts = Cache::mergeContexts($this->cacheContexts, $cache_contexts); return $this; } @@ -63,9 +61,7 @@ public function addCacheContexts(array $cache_contexts) { * {@inheritdoc} */ public function addCacheTags(array $cache_tags) { - if ($cache_tags) { - $this->cacheTags = Cache::mergeTags($this->cacheTags, $cache_tags); - } + $this->cacheTags = Cache::mergeTags($this->cacheTags, $cache_tags); return $this; } diff --git a/core/lib/Drupal/Core/Database/Connection.php b/core/lib/Drupal/Core/Database/Connection.php index 5c32665..61e53dd 100644 --- a/core/lib/Drupal/Core/Database/Connection.php +++ b/core/lib/Drupal/Core/Database/Connection.php @@ -1234,13 +1234,6 @@ public function version() { } /** - * Returns the version of the database client. - */ - public function clientVersion() { - return $this->connection->getAttribute(\PDO::ATTR_CLIENT_VERSION); - } - - /** * Determines if this driver supports transactions. * * @return bool diff --git a/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php b/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php index c48c275..4bc3c29 100644 --- a/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php +++ b/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php @@ -29,11 +29,6 @@ class Connection extends DatabaseConnection { const DATABASE_NOT_FOUND = 1049; /** - * Error code for "Can't initialize character set" error. - */ - const UNSUPPORTED_CHARSET = 2019; - - /** * Flag to indicate if the cleanup function in __destruct() should run. * * @var bool @@ -87,13 +82,6 @@ public function query($query, array $args = array(), $options = array()) { * {@inheritdoc} */ public static function open(array &$connection_options = array()) { - if (isset($connection_options['_dsn_utf8_fallback']) && $connection_options['_dsn_utf8_fallback'] === TRUE) { - // Only used during the installer version check, as a fallback from utf8mb4. - $charset = 'utf8'; - } - else { - $charset = 'utf8mb4'; - } // The DSN should use either a socket or a host/port. if (isset($connection_options['unix_socket'])) { $dsn = 'mysql:unix_socket=' . $connection_options['unix_socket']; @@ -105,7 +93,7 @@ public static function open(array &$connection_options = array()) { // Character set is added to dsn to ensure PDO uses the proper character // set when escaping. This has security implications. See // https://www.drupal.org/node/1201452 for further discussion. - $dsn .= ';charset=' . $charset; + $dsn .= ';charset=utf8mb4'; if (!empty($connection_options['database'])) { $dsn .= ';dbname=' . $connection_options['database']; } @@ -136,10 +124,10 @@ public static function open(array &$connection_options = array()) { // certain one has been set; otherwise, MySQL defaults to // 'utf8mb4_general_ci' for utf8mb4. if (!empty($connection_options['collation'])) { - $pdo->exec('SET NAMES ' . $charset . ' COLLATE ' . $connection_options['collation']); + $pdo->exec('SET NAMES utf8mb4 COLLATE ' . $connection_options['collation']); } else { - $pdo->exec('SET NAMES ' . $charset); + $pdo->exec('SET NAMES utf8mb4'); } // Set MySQL init_commands if not already defined. Default Drupal's MySQL diff --git a/core/lib/Drupal/Core/Database/Driver/mysql/Install/Tasks.php b/core/lib/Drupal/Core/Database/Driver/mysql/Install/Tasks.php index 754989f..19fbe5f 100644 --- a/core/lib/Drupal/Core/Database/Driver/mysql/Install/Tasks.php +++ b/core/lib/Drupal/Core/Database/Driver/mysql/Install/Tasks.php @@ -16,17 +16,6 @@ * Specifies installation tasks for MySQL and equivalent databases. */ class Tasks extends InstallTasks { - - /** - * Minimum required MySQLnd version. - */ - const MYSQLND_MINIMUM_VERSION = '5.0.9'; - - /** - * Minimum required libmysqlclient version. - */ - const LIBMYSQLCLIENT_MINIMUM_VERSION = '5.5.3'; - /** * The PDO driver name for MySQL and equivalent databases. * @@ -39,6 +28,13 @@ class Tasks extends InstallTasks { */ public function __construct() { $this->tasks[] = array( + 'arguments' => array( + 'SET NAMES utf8mb4', + 'The %name database server supports utf8mb4 character encoding.', + 'The %name database server must support utf8mb4 character encoding to work with Drupal. Make sure to use a database server that supports utf8mb4 character encoding, such as MySQL/MariaDB/Percona versions 5.5.3 and up.', + ), + ); + $this->tasks[] = array( 'arguments' => array(), 'function' => 'ensureInnoDbAvailable', ); @@ -66,34 +62,7 @@ protected function connect() { // This doesn't actually test the connection. db_set_active(); // Now actually do a check. - try { - Database::getConnection(); - } - catch (\Exception $e) { - // Detect utf8mb4 incompability. - if ($e->getCode() == Connection::UNSUPPORTED_CHARSET) { - $this->fail(t('Your MySQL server and PHP MySQL driver must support utf8mb4 character encoding. Make sure to use a database system that supports this (such as MySQL/MariaDB/Percona 5.5.3 and up), and that the utf8mb4 character set is compiled in. See the MySQL documentation for more information.', array('@documentation' => 'https://dev.mysql.com/doc/refman/5.0/en/cannot-initialize-character-set.html'))); - $info = Database::getConnectionInfo(); - $info_copy = $info; - // Set a flag to fall back to utf8. Note: this flag should only be - // used here and is for internal use only. - $info_copy['default']['_dsn_utf8_fallback'] = TRUE; - // In order to change the Database::$databaseInfo array, we need to - // remove the active connection, then re-add it with the new info. - Database::removeConnection('default'); - Database::addConnectionInfo('default', 'default', $info_copy['default']); - // Connect with the new database info, using the utf8 character set so - // that we can run the checkEngineVersion test. - Database::getConnection(); - // Revert to the old settings. - Database::removeConnection('default'); - Database::addConnectionInfo('default', 'default', $info['default']); - } - else { - // Rethrow the exception. - throw $e; - } - } + Database::getConnection(); $this->pass('Drupal can CONNECT to the database ok.'); } catch (\Exception $e) { @@ -152,27 +121,4 @@ function ensureInnoDbAvailable() { } } - /** - * {@inheritdoc} - */ - protected function checkEngineVersion() { - parent::checkEngineVersion(); - - // Ensure that the MySQL driver supports utf8mb4 encoding. - $version = Database::getConnection()->clientVersion(); - if (FALSE !== strpos($version, 'mysqlnd')) { - // The mysqlnd driver supports utf8mb4 starting at version 5.0.9. - $version = preg_replace('/^\D+([\d.]+).*/', '$1', $version); - if (version_compare($version, self::MYSQLND_MINIMUM_VERSION, '<')) { - $this->fail(t("The MySQLnd driver version %version is less than the minimum required version. Upgrade to MySQLnd version %mysqlnd_minimum_version or up, or alternatively switch mysql drivers to libmysqlclient version %libmysqlclient_minimum_version or up.", array('%version' => Database::getConnection()->version(), '%mysqlnd_minimum_version' => self::MYSQLND_MINIMUM_VERSION, '%libmysqlclient_minimum_version' => self::LIBMYSQLCLIENT_MINIMUM_VERSION))); - } - } - else { - // The libmysqlclient driver supports utf8mb4 starting at version 5.5.3. - if (version_compare($version, self::LIBMYSQLCLIENT_MINIMUM_VERSION, '<')) { - $this->fail(t("The libmysqlclient driver version %version is less than the minimum required version. Upgrade to libmysqlclient version %libmysqlclient_minimum_version or up, or alternatively switch mysql drivers to MySQLnd version %mysqlnd_minimum_version or up.", array('%version' => Database::getConnection()->version(), '%libmysqlclient_minimum_version' => self::LIBMYSQLCLIENT_MINIMUM_VERSION, '%mysqlnd_minimum_version' => self::MYSQLND_MINIMUM_VERSION))); - } - } - } - } diff --git a/core/lib/Drupal/Core/Database/Install/Tasks.php b/core/lib/Drupal/Core/Database/Install/Tasks.php index fed2c5e..ae94242 100644 --- a/core/lib/Drupal/Core/Database/Install/Tasks.php +++ b/core/lib/Drupal/Core/Database/Install/Tasks.php @@ -192,9 +192,8 @@ protected function runTestQuery($query, $pass, $fail, $fatal = FALSE) { * Check the engine version. */ protected function checkEngineVersion() { - // Ensure that the database server has the right version. if ($this->minimumVersion() && version_compare(Database::getConnection()->version(), $this->minimumVersion(), '<')) { - $this->fail(t("The database server version %version is less than the minimum required version %minimum_version.", array('%version' => Database::getConnection()->version(), '%minimum_version' => $this->minimumVersion()))); + $this->fail(t("The database version %version is less than the minimum required version %minimum_version.", array('%version' => Database::getConnection()->version(), '%minimum_version' => $this->minimumVersion()))); } } diff --git a/core/lib/Drupal/Core/Entity/EntityDisplayBase.php b/core/lib/Drupal/Core/Entity/EntityDisplayBase.php index 79b9292..3a59e01 100644 --- a/core/lib/Drupal/Core/Entity/EntityDisplayBase.php +++ b/core/lib/Drupal/Core/Entity/EntityDisplayBase.php @@ -256,9 +256,19 @@ public function calculateDependencies() { parent::calculateDependencies(); $target_entity_type = $this->entityManager()->getDefinition($this->targetEntityType); - // Create dependency on the bundle. - $bundle_config_dependency = $target_entity_type->getBundleConfigDependency($this->bundle); - $this->addDependency($bundle_config_dependency['type'], $bundle_config_dependency['name']); + $bundle_entity_type_id = $target_entity_type->getBundleEntityType(); + if ($bundle_entity_type_id != 'bundle') { + // If the target entity type uses entities to manage its bundles then + // depend on the bundle entity. + if (!$bundle_entity = $this->entityManager()->getStorage($bundle_entity_type_id)->load($this->bundle)) { + throw new \LogicException("Missing bundle entity, entity type $bundle_entity_type_id, entity id {$this->bundle}."); + } + $this->addDependency('config', $bundle_entity->getConfigDependencyName()); + } + else { + // Depend on the provider of the entity type. + $this->addDependency('module', $target_entity_type->getProvider()); + } // If field.module is enabled, add dependencies on 'field_config' entities // for both displayed and hidden fields. We intentionally leave out base diff --git a/core/lib/Drupal/Core/Entity/EntityType.php b/core/lib/Drupal/Core/Entity/EntityType.php index 3a32d4a..31c7923 100644 --- a/core/lib/Drupal/Core/Entity/EntityType.php +++ b/core/lib/Drupal/Core/Entity/EntityType.php @@ -119,7 +119,7 @@ class EntityType implements EntityTypeInterface { * * @var string */ - protected $bundle_entity_type = NULL; + protected $bundle_entity_type = 'bundle'; /** * The name of the entity type for which bundles are provided. @@ -764,30 +764,4 @@ public function addConstraint($constraint_name, $options = NULL) { return $this; } - /** - * {@inheritdoc} - */ - public function getBundleConfigDependency($bundle) { - // If this entity type uses entities to manage its bundles then depend on - // the bundle entity. - if ($bundle_entity_type_id = $this->getBundleEntityType()) { - if (!$bundle_entity = \Drupal::entityManager()->getStorage($bundle_entity_type_id)->load($bundle)) { - throw new \LogicException(sprintf('Missing bundle entity, entity type %s, entity id %s.', $bundle_entity_type_id, $bundle)); - } - $config_dependency = [ - 'type' => 'config', - 'name' => $bundle_entity->getConfigDependencyName(), - ]; - } - else { - // Depend on the provider of the entity type. - $config_dependency = [ - 'type' => 'module', - 'name' => $this->getProvider(), - ]; - } - - return $config_dependency; - } - } diff --git a/core/lib/Drupal/Core/Entity/EntityTypeInterface.php b/core/lib/Drupal/Core/Entity/EntityTypeInterface.php index 1a3805e..46c2058 100644 --- a/core/lib/Drupal/Core/Entity/EntityTypeInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityTypeInterface.php @@ -732,17 +732,4 @@ public function setConstraints(array $constraints); */ public function addConstraint($constraint_name, $options = NULL); - /** - * Gets the config dependency info for this entity, if any exists. - * - * @param string $bundle - * The bundle name. - * - * @return array - * An associative array containing the following keys: - * - 'type': The config dependency type (e.g. 'module', 'config'). - * - 'name': The name of the config dependency. - */ - public function getBundleConfigDependency($bundle); - } diff --git a/core/lib/Drupal/Core/Field/FieldConfigBase.php b/core/lib/Drupal/Core/Field/FieldConfigBase.php index 3f13e1d..00fc567 100644 --- a/core/lib/Drupal/Core/Field/FieldConfigBase.php +++ b/core/lib/Drupal/Core/Field/FieldConfigBase.php @@ -248,10 +248,15 @@ public function calculateDependencies() { // @see \Drupal\Core\Field\FieldItemInterface::calculateDependencies() $this->addDependencies($definition['class']::calculateDependencies($this)); - // Create dependency on the bundle. - $bundle_config_dependency = $this->entityManager()->getDefinition($this->entity_type)->getBundleConfigDependency($this->bundle); - $this->addDependency($bundle_config_dependency['type'], $bundle_config_dependency['name']); - + // If the target entity type uses entities to manage its bundles then + // depend on the bundle entity. + $bundle_entity_type_id = $this->entityManager()->getDefinition($this->entity_type)->getBundleEntityType(); + if ($bundle_entity_type_id != 'bundle') { + if (!$bundle_entity = $this->entityManager()->getStorage($bundle_entity_type_id)->load($this->bundle)) { + throw new \LogicException("Missing bundle entity, entity type {$bundle_entity_type_id}, entity id {$this->bundle}."); + } + $this->addDependency('config', $bundle_entity->getConfigDependencyName()); + } return $this->dependencies; } diff --git a/core/lib/Drupal/Core/Menu/LocalTaskInterface.php b/core/lib/Drupal/Core/Menu/LocalTaskInterface.php index 5898710..4a2b351 100644 --- a/core/lib/Drupal/Core/Menu/LocalTaskInterface.php +++ b/core/lib/Drupal/Core/Menu/LocalTaskInterface.php @@ -11,12 +11,6 @@ /** * Defines an interface for menu local tasks. - * - * Menu local tasks are are typically rendered as navigation tabs above the - * content region, though other presentations are possible. It is convention - * that the titles of these tasks should be short verbs if possible. - * - * @see \Drupal\Core\Menu\LocalTaskManagerInterface */ interface LocalTaskInterface { diff --git a/core/lib/Drupal/Core/Menu/menu.api.php b/core/lib/Drupal/Core/Menu/menu.api.php index e68b795..a2e9bb0 100644 --- a/core/lib/Drupal/Core/Menu/menu.api.php +++ b/core/lib/Drupal/Core/Menu/menu.api.php @@ -562,8 +562,12 @@ function hook_contextual_links_plugins_alter(array &$contextual_links) { /** * Perform alterations to the breadcrumb built by the BreadcrumbManager. * - * @param \Drupal\Core\Breadcrumb\Breadcrumb $breadcrumb - * A breadcrumb object returned by BreadcrumbBuilderInterface::build(). + * @param array $breadcrumb + * An array of breadcrumb link a tags, returned by the breadcrumb manager + * build method, for example + * @code + * array('Home'); + * @endcode * @param \Drupal\Core\Routing\RouteMatchInterface $route_match * The current route match. * @param array $context @@ -574,9 +578,9 @@ function hook_contextual_links_plugins_alter(array &$contextual_links) { * * @ingroup menu */ -function hook_system_breadcrumb_alter(\Drupal\Core\Breadcrumb\Breadcrumb &$breadcrumb, \Drupal\Core\Routing\RouteMatchInterface $route_match, array $context) { +function hook_system_breadcrumb_alter(array &$breadcrumb, \Drupal\Core\Routing\RouteMatchInterface $route_match, array $context) { // Add an item to the end of the breadcrumb. - $breadcrumb->addLink(Drupal::l(t('Text'), 'example_route_name')); + $breadcrumb[] = Drupal::l(t('Text'), 'example_route_name'); } /** diff --git a/core/lib/Drupal/Core/Render/Element/HtmlTag.php b/core/lib/Drupal/Core/Render/Element/HtmlTag.php index 195dc6e..44bf835 100644 --- a/core/lib/Drupal/Core/Render/Element/HtmlTag.php +++ b/core/lib/Drupal/Core/Render/Element/HtmlTag.php @@ -8,7 +8,6 @@ namespace Drupal\Core\Render\Element; use Drupal\Component\Utility\SafeMarkup; -use Drupal\Core\Render\SafeString; use Drupal\Component\Utility\Xss; use Drupal\Core\Template\Attribute; @@ -47,8 +46,13 @@ public function getInfo() { /** * Pre-render callback: Renders a generic HTML tag with attributes into #markup. * - * Note: It is the caller's responsibility to sanitize #value_prefix and - * #value_suffix. They are not filtered by this function. + * Note: It is the caller's responsibility to sanitize any input parameters. + * This callback does not perform sanitization. Despite the result of this + * pre-render callback being a #markup element, it is not passed through + * \Drupal\Component\Utility\Xss::filterAdmin(). This is because it is marked + * safe here, which causes + * \Drupal\Core\Render\Renderer::xssFilterAdminIfUnsafe() to regard it as safe + * and bypass the call to \Drupal\Component\Utility\Xss::filterAdmin(). * * @param array $element * An associative array containing: @@ -56,17 +60,16 @@ public function getInfo() { * - meta: To provide meta information, such as a page refresh. * - link: To refer to stylesheets and other contextual information. * - script: To load JavaScript. - * The value of #tag is escaped. + * The value of #tag is not escaped or sanitized, so do not pass in user + * input. * - #attributes: (optional) An array of HTML attributes to apply to the - * tag. The attributes are escaped, see \Drupal\Core\Template\Attribute. + * tag. * - #value: (optional) A string containing tag content, such as inline - * CSS. The value of #value will be XSS admin filtered if it is not safe. + * CSS. * - #value_prefix: (optional) A string to prepend to #value, e.g. a CDATA - * wrapper prefix. The value of #value_prefix cannot be filtered and is - * assumed to be safe. + * wrapper prefix. * - #value_suffix: (optional) A string to append to #value, e.g. a CDATA - * wrapper suffix. The value of #value_suffix cannot be filtered and is - * assumed to be safe. + * wrapper suffix. * - #noscript: (optional) If TRUE, the markup (including any prefix or * suffix) will be wrapped in a