common.inc 177 KB
Newer Older
Dries's avatar
Dries committed
1 2
<?php

3 4 5 6 7 8 9 10
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

11
use Drupal\Component\Serialization\Json;
12
use Drupal\Component\Utility\Crypt;
13
use Drupal\Component\Utility\Number;
14
use Drupal\Component\Utility\Settings;
15
use Drupal\Component\Utility\SortArray;
16
use Drupal\Component\Utility\String;
17
use Drupal\Component\Utility\Tags;
18
use Drupal\Component\Utility\UrlHelper;
19
use Drupal\Component\Utility\Xss;
20
use Drupal\Core\Cache\Cache;
21
use Drupal\Core\Language\Language;
22 23
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
24 25
use Symfony\Component\Yaml\Parser;
use Symfony\Component\Yaml\Exception\ParseException;
26
use Drupal\Core\PhpStorage\PhpStorageFactory;
27
use Drupal\Component\Utility\NestedArray;
28
use Drupal\Core\Datetime\DrupalDateTime;
29
use Drupal\Core\EventSubscriber\HtmlViewSubscriber;
30
use Drupal\Core\Routing\GeneratorNotInitializedException;
31
use Drupal\Core\Template\Attribute;
32
use Drupal\Core\Render\Element;
33
use Drupal\Core\Session\AnonymousUserSession;
34

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
/**
 * @defgroup php_wrappers PHP wrapper functions
 * @{
 * Functions that are wrappers or custom implementations of PHP functions.
 *
 * Certain PHP functions should not be used in Drupal. Instead, Drupal's
 * replacement functions should be used.
 *
 * For example, for improved or more secure UTF8-handling, or RFC-compliant
 * handling of URLs in Drupal.
 *
 * For ease of use and memorizing, all these wrapper functions use the same name
 * as the original PHP function, but prefixed with "drupal_". Beware, however,
 * that not all wrapper functions support the same arguments as the original
 * functions.
 *
 * You should always use these wrapper functions in your code.
 *
 * Wrong:
 * @code
 *   $my_substring = substr($original_string, 0, 5);
 * @endcode
 *
 * Correct:
 * @code
 *   $my_substring = drupal_substr($original_string, 0, 5);
 * @endcode
 *
63
 * @}
64 65
 */

66 67 68
/**
 * Return status for saving which involved creating a new item.
 */
69
const SAVED_NEW = 1;
70 71 72 73

/**
 * Return status for saving which involved an update to an existing item.
 */
74
const SAVED_UPDATED = 2;
75 76 77 78

/**
 * Return status for saving which deleted an existing item.
 */
79
const SAVED_DELETED = 3;
80

81
/**
82
 * The default aggregation group for CSS files added to the page.
83
 */
84
const CSS_AGGREGATE_DEFAULT = 0;
85 86

/**
87
 * The default aggregation group for theme CSS files added to the page.
88
 */
89 90 91 92 93 94 95 96 97 98 99 100 101
const CSS_AGGREGATE_THEME = 100;

/**
 * The default weight for CSS rules that style HTML elements ("base" styles).
 */
const CSS_BASE = -200;

/**
 * The default weight for CSS rules that layout a page.
 */
const CSS_LAYOUT = -100;

/**
102
 * The default weight for CSS rules that style design components (and their associated states and themes.)
103 104 105 106 107 108 109 110 111
 */
const CSS_COMPONENT = 0;

/**
 * The default weight for CSS rules that style states and are not included with components.
 */
const CSS_STATE = 100;

/**
112
 * The default weight for CSS rules that style themes and are not included with components.
113
 */
114
const CSS_THEME = 200;
115

116 117 118 119 120
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

121
/**
122
 * The default group for JavaScript and jQuery libraries added to the page.
123
 */
124
const JS_LIBRARY = -100;
125 126

/**
127
 * The default group for module JavaScript code added to the page.
128
 */
129
const JS_DEFAULT = 0;
130 131

/**
132
 * The default group for theme JavaScript code added to the page.
133
 */
134
const JS_THEME = 100;
135

136 137 138 139 140 141 142 143 144
/**
 * The delimiter used to split plural strings.
 *
 * This is the ETX (End of text) character and is used as a minimal means to
 * separate singular and plural variants in source and translation text. It
 * was found to be the most compatible delimiter for the supported databases.
 */
const LOCALE_PLURAL_DELIMITER = "\03";

145
/**
146
 * Adds content to a specified region.
147 148
 *
 * @param $region
149
 *   Page region the content is added to.
150
 * @param $data
151
 *   Content to be added.
152
 */
153
function drupal_add_region_content($region = NULL, $data = NULL) {
154 155
  static $content = array();

156
  if (isset($region) && isset($data)) {
157 158 159 160 161 162
    $content[$region][] = $data;
  }
  return $content;
}

/**
163
 * Gets assigned content for a given region.
164 165
 *
 * @param $region
166 167
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
168
 * @param $delimiter
169
 *   Content to be inserted between imploded array elements.
170
 */
171 172
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
173 174
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
175
      return implode($delimiter, $content[$region]);
176
    }
177 178 179 180
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
181
        $content[$region] = implode($delimiter, $content[$region]);
182 183 184 185 186 187
      }
    }
    return $content;
  }
}

188
/**
189
 * Gets the name of the currently active installation profile.
190 191 192
 *
 * When this function is called during Drupal's initial installation process,
 * the name of the profile that's about to be installed is stored in the global
193 194
 * installation state. At all other times, the "install_profile" setting will be
 * available in settings.php.
195
 *
196 197 198 199
 * @return string|null $profile
 *   The name of the installation profile or NULL if no installation profile is
 *   currently active. This is the case for example during the first steps of
 *   the installer or during unit tests.
200 201 202 203
 */
function drupal_get_profile() {
  global $install_state;

204 205 206 207 208 209
  if (drupal_installation_attempted()) {
    // If the profile has been selected return it.
    if (isset($install_state['parameters']['profile'])) {
      $profile = $install_state['parameters']['profile'];
    }
    else {
210
      $profile = NULL;
211
    }
212 213
  }
  else {
214 215
    // Fall back to NULL, if there is no 'install_profile' setting.
    $profile = Settings::get('install_profile');
216 217 218 219 220
  }

  return $profile;
}

Dries's avatar
Dries committed
221
/**
222
 * Adds output to the HEAD tag of the HTML page.
223
 *
224
 * This function can be called as long as the headers aren't sent. Pass no
225 226 227 228 229 230 231 232 233 234 235 236
 * arguments (or NULL for both) to retrieve the currently stored elements.
 *
 * @param $data
 *   A renderable array. If the '#type' key is not set then 'html_tag' will be
 *   added as the default '#type'.
 * @param $key
 *   A unique string key to allow implementations of hook_html_head_alter() to
 *   identify the element in $data. Required if $data is not NULL.
 *
 * @return
 *   An array of all stored HEAD elements.
 *
237
 * @see drupal_pre_render_html_tag()
Dries's avatar
Dries committed
238
 */
239 240
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
241

242 243 244 245 246 247 248 249 250 251
  if (!isset($stored_head)) {
    // Make sure the defaults, including Content-Type, come first.
    $stored_head = _drupal_default_html_head();
  }

  if (isset($data) && isset($key)) {
    if (!isset($data['#type'])) {
      $data['#type'] = 'html_tag';
    }
    $stored_head[$key] = $data;
Dries's avatar
Dries committed
252 253 254 255
  }
  return $stored_head;
}

256
/**
257 258 259 260 261 262 263 264 265 266
 * Returns elements that are always displayed in the HEAD tag of the HTML page.
 */
function _drupal_default_html_head() {
  // Add default elements. Make sure the Content-Type comes first because the
  // IE browser may be vulnerable to XSS via encoding attacks from any content
  // that comes before this META tag, such as a TITLE tag.
  $elements['system_meta_content_type'] = array(
    '#type' => 'html_tag',
    '#tag' => 'meta',
    '#attributes' => array(
267
      'charset' => 'utf-8',
268 269 270 271 272 273
    ),
    // Security: This always has to be output first.
    '#weight' => -1000,
  );
  // Show Drupal and the major version number in the META GENERATOR tag.
  // Get the major version.
274
  list($version, ) = explode('.', \Drupal::VERSION);
275 276 277 278 279 280 281 282 283 284 285 286 287 288
  $elements['system_meta_generator'] = array(
    '#type' => 'html_tag',
    '#tag' => 'meta',
    '#attributes' => array(
      'name' => 'Generator',
      'content' => 'Drupal ' . $version . ' (http://drupal.org)',
    ),
  );
  // Also send the generator in the HTTP header.
  $elements['system_meta_generator']['#attached']['drupal_add_http_header'][] = array('X-Generator', $elements['system_meta_generator']['#attributes']['content']);
  return $elements;
}

/**
289
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
290
  */
Dries's avatar
Dries committed
291
function drupal_get_html_head() {
292
  $elements = drupal_add_html_head();
293
  \Drupal::moduleHandler()->alter('html_head', $elements);
294
  return drupal_render($elements);
Dries's avatar
Dries committed
295 296
}

297
/**
298
 * Adds a feed URL for the current page.
299
 *
300 301
 * This function can be called as long the HTML header hasn't been sent.
 *
302
 * @param $url
303
 *   An internal system path or a fully qualified external URL of the feed.
304
 * @param $title
305
 *   The title of the feed.
306
 */
307
function drupal_add_feed($url = NULL, $title = '') {
308
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
309

310
  if (isset($url)) {
311 312 313 314 315
    $feed_icon = array(
      '#theme' => 'feed_icon',
      '#url' => $url,
      '#title' => $title,
    );
316

317
    $feed_icon['#attached']['drupal_add_html_head_link'][][] = array(
318 319 320 321 322 323
      'rel' => 'alternate',
      'type' => 'application/rss+xml',
      'title' => $title,
      // Force the URL to be absolute, for consistency with other <link> tags
      // output by Drupal.
      'href' => url($url, array('absolute' => TRUE)),
324
    );
325 326

    $stored_feed_links[$url] = drupal_render($feed_icon);
327 328 329 330 331
  }
  return $stored_feed_links;
}

/**
332
 * Gets the feed URLs for the current page.
333 334
 *
 * @param $delimiter
335
 *   A delimiter to split feeds by.
336 337 338 339 340 341
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

342
/**
343
 * @defgroup http_handling HTTP handling
344
 * @{
345
 * Functions to properly handle HTTP responses.
346 347
 */

348
/**
349
 * Processes a URL query parameter array to remove unwanted elements.
350 351
 *
 * @param $query
352 353
 *   (optional) An array to be processed. Defaults to \Drupal::request()->query
 *   parameters.
354
 * @param $exclude
355
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
356
 *   exclude nested items.
357
 * @param $parent
358 359
 *   Internal use only. Used to build the $query array key for nested items.
 *
360
 * @return
361
 *   An array containing query parameters, which can be used for url().
362
 *
363
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
364
 *   Use \Drupal\Component\Utility\UrlHelper::filterQueryParameters().
365
 */
366
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
367
  if (!isset($query)) {
368
    $query = \Drupal::request()->query->all();
369
  }
370
  return UrlHelper::filterQueryParameters($query, $exclude, $parent);
371 372
}

373
/**
374
 * Parses an array into a valid, rawurlencoded query string.
375 376 377
 *
 * @see drupal_get_query_parameters()
 * @ingroup php_wrappers
378
 *
379
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
380
 *   Use \Drupal\Component\Utility\UrlHelper::buildQuery().
381 382
 */
function drupal_http_build_query(array $query, $parent = '') {
383
  return UrlHelper::buildQuery($query, $parent);
384 385
}

386
/**
387
 * Prepares a 'destination' URL query parameter for use with url().
388
 *
389 390 391 392
 * Used to direct the user back to the referring page after completing a form.
 * By default the current URL is returned. If a destination exists in the
 * previous request, that destination is returned. As such, a destination can
 * persist across multiple pages.
393
 *
394 395 396 397 398 399
 * @return
 *   An associative array containing the key:
 *   - destination: The path provided via the destination query string or, if
 *     not available, the current path.
 *
 * @see current_path()
400 401
 */
function drupal_get_destination() {
402 403 404 405 406 407
  $destination = &drupal_static(__FUNCTION__);

  if (isset($destination)) {
    return $destination;
  }

408
  $query = \Drupal::request()->query;
409 410
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
411 412
  }
  else {
413
    $path = current_path();
414
    $query = UrlHelper::buildQuery(UrlHelper::filterQueryParameters($query->all()));
415
    if ($query != '') {
416
      $path .= '?' . $query;
417
    }
418 419 420 421 422 423
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
424
 * Parses a system URL string into an associative array suitable for url().
425 426
 *
 * This function should only be used for URLs that have been generated by the
427 428
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
429 430 431 432
 *
 * The returned array contains a 'path' that may be passed separately to url().
 * For example:
 * @code
433
 *   $options = drupal_parse_url(\Drupal::request()->query->get('destination'));
434 435 436 437 438 439 440 441 442 443
 *   $my_url = url($options['path'], $options);
 *   $my_link = l('Example link', $options['path'], $options);
 * @endcode
 *
 * This is required, because url() does not support relative URLs containing a
 * query string or fragment in its $path argument. Instead, any query string
 * needs to be parsed into an associative query parameter array in
 * $options['query'] and the fragment into $options['fragment'].
 *
 * @param $url
444
 *   The URL string to parse.
445 446 447 448 449 450 451 452 453 454
 *
 * @return
 *   An associative array containing the keys:
 *   - 'path': The path of the URL. If the given $url is external, this includes
 *     the scheme and host.
 *   - 'query': An array of query parameters of $url, if existent.
 *   - 'fragment': The fragment of $url, if existent.
 *
 * @see url()
 * @ingroup php_wrappers
455
 *
456
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
457
 *   Use \Drupal\Component\Utility\UrlHelper::parse().
458 459
 */
function drupal_parse_url($url) {
460
  return UrlHelper::parse($url);
461 462 463
}

/**
464
 * Encodes a Drupal path for use in a URL.
465
 *
466
 * For aesthetic reasons slashes are not escaped.
467
 *
468 469
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
470 471
 *
 * @param $path
472
 *   The Drupal path to encode.
473
 *
474
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
475
 *   Use \Drupal\Component\Utility\UrlHelper::encodePath().
476 477
 */
function drupal_encode_path($path) {
478
  return UrlHelper::encodePath($path);
479 480
}

481 482 483 484 485 486 487 488
/**
 * Determines if an external URL points to this Drupal installation.
 *
 * @param $url
 *   A string containing an external URL, such as "http://example.com/foo".
 *
 * @return
 *   TRUE if the URL has the same domain and base path.
489
 *
490
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
491
 *   Use \Drupal\Component\Utility\UrlHelper::externalIsLocal().
492 493
 */
function _external_url_is_local($url) {
494
  return UrlHelper::externalIsLocal($url, base_path());
495 496
}

497 498 499 500 501 502 503
/**
 * Helper function for determining hosts excluded from needing a proxy.
 *
 * @return
 *   TRUE if a proxy should be used for this host.
 */
function _drupal_http_use_proxy($host) {
504
  $proxy_exceptions = Settings::get('proxy_exceptions', array('localhost', '127.0.0.1'));
505 506 507
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

508
/**
509
 * @} End of "defgroup http_handling".
510
 */
511

512
/**
513
 * @defgroup validation Input validation
514
 * @{
515
 * Functions to validate user input.
516 517
 */

518
/**
519
 * Verifies the syntax of the given e-mail address.
520
 *
521 522
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
523
 *
524
 * @param $mail
525
 *   A string containing an e-mail address.
526
 *
527
 * @return
528
 *   TRUE if the address is in a valid format.
529
 */
530
function valid_email_address($mail) {
531
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
532 533
}

534
/**
535
 * Verifies the syntax of the given URL.
536
 *
537 538
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
539
 * Valid values per RFC 3986.
540
 * @param $url
541
 *   The URL to verify.
542
 * @param $absolute
543
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
544
 *
545
 * @return
546
 *   TRUE if the URL is in a valid format.
547
 *
548
 * @see \Drupal\Component\Utility\UrlHelper::isValid()
549
 *
550
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
551
 *   Use \Drupal\Component\Utility\UrlHelper::isValid().
552
 */
553
function valid_url($url, $absolute = FALSE) {
554
  return UrlHelper::isValid($url, $absolute);
555 556
}

557 558 559 560
/**
 * @} End of "defgroup validation".
 */

561 562 563 564
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
565 566 567
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
568 569
 */

570
/**
571
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
572 573 574 575 576 577 578
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
 * @return
 *   A URI stripped of dangerous protocols and encoded for output to an HTML
 *   attribute value. Because it is already encoded, it should not be set as a
579 580 581
 *   value within a $attributes array passed to Drupal\Core\Template\Attribute,
 *   because Drupal\Core\Template\Attribute expects those values to be
 *   plain-text strings. To pass a filtered URI to
582
 *   Drupal\Core\Template\Attribute, call
583
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
584
 *
585
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
586
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
587 588
 */
function check_url($uri) {
589
  return String::checkPlain(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
590 591
}

592
/**
593
 * Applies a very permissive XSS/HTML filter for admin-only use.
594 595 596
 *
 * Use only for fields where it is impractical to use the
 * whole filter system, but where some (mainly inline) mark-up
597 598
 * is desired (so \Drupal\Component\Utility\String::checkPlain() is not
 * acceptable).
599 600 601
 *
 * Allows all tags that can be used inside an HTML body, save
 * for scripts and styles.
602 603 604 605 606 607 608 609
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
610 611
 */
function filter_xss_admin($string) {
612
  return Xss::filterAdmin($string);
613 614 615
}

/**
616
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
617
 *
618 619
 * Based on kses by Ulf Harnhammar, see http://sourceforge.net/projects/kses.
 * For examples of various XSS attacks, see: http://ha.ckers.org/xss.html.
620 621
 *
 * This code does four things:
622 623 624 625 626
 * - Removes characters and constructs that can trick browsers.
 * - Makes sure all HTML entities are well-formed.
 * - Makes sure all HTML tags and attributes are well-formed.
 * - Makes sure no HTML tags contain URLs with a disallowed protocol (e.g.
 *   javascript:).
627 628
 *
 * @param $string
629 630
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
631 632
 * @param $allowed_tags
 *   An array of allowed tags.
633 634 635 636 637
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
638
 * @see \Drupal\Component\Utility\Xss::filter()
639 640
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
641
  return Xss::filter($string, $allowed_tags);
642 643 644
}

/**
645
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
646
 *
647
 * @param string $string
648
 *   The string with the attribute value.
649
 *
650
 * @return string
651
 *   Cleaned up and HTML-escaped version of $string.
652
 *
653
 * @see \Drupal\Component\Utility\UrlHelper::filterBadProtocol()
654
 */
655
function filter_xss_bad_protocol($string) {
656
  return UrlHelper::filterBadProtocol($string);
657 658 659 660 661 662
}

/**
 * @} End of "defgroup sanitization".
 */

663
/**
664
 * @defgroup format Formatting
665
 * @{
666
 * Functions to format numbers, strings, dates, etc.
667 668
 */

669 670 671 672 673
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
674
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
675
  $langcode = $langcode ? $langcode : \Drupal::languageManager()->getCurrentLanguage(Language::TYPE_CONTENT)->id;
Dries's avatar
Dries committed
676

Dries's avatar
Dries committed
677
  $output = "<channel>\n";
678
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
679
  $output .= ' <link>' . check_url($link) . "</link>\n";
680 681 682 683

  // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
  // We strip all HTML tags, but need to prevent double encoding from properly
  // escaped source data (such as &amp becoming &amp;amp;).
684 685
  $output .= ' <description>' . String::checkPlain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . String::checkPlain($langcode) . "</language>\n";
686
  $output .= format_xml_elements($args);
Dries's avatar
Dries committed
687 688 689 690 691 692
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

693
/**
694
 * Formats a single RSS item.
695 696 697
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
Dries committed
698
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
699
  $output = "<item>\n";
700
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
701
  $output .= ' <link>' . check_url($link) . "</link>\n";
702
  $output .= ' <description>' . String::checkPlain($description) . "</description>\n";
703 704 705 706 707 708 709
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
710
 * Formats XML elements.
711 712
 *
 * @param $array
713
 *   An array where each item represents an element and is either a:
714 715 716 717 718 719 720 721 722 723
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
 *     - 'key': element name
 *     - 'value': element contents
 *     - 'attributes': associative array of element attributes
 *
 * In both cases, 'value' can be a simple string, or it can be another array
 * with the same format as $array itself for nesting.
 */
function format_xml_elements($array) {
724
  $output = '';
725 726
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
727
      if ($value['key']) {
728
        $output .= ' <' . $value['key'];
729
        if (isset($value['attributes']) && is_array($value['attributes'])) {
730
          $output .= new Attribute($value['attributes']);
731 732
        }

733
        if (isset($value['value']) && $value['value'] != '') {
734
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
735 736 737 738 739 740 741
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
742
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
743
    }
Dries's avatar
Dries committed
744
  }
Dries's avatar
Dries committed
745 746 747
  return $output;
}

748
/**
749
 * Formats a string containing a count of items.
750
 *
751
 * This function ensures that the string is pluralized correctly. Since t() is
752 753
 * called by this function, make sure not to pass already-localized strings to
 * it.
754
 *
755 756 757 758 759 760 761 762 763 764
 * For example:
 * @code
 *   $output = format_plural($node->comment_count, '1 comment', '@count comments');
 * @endcode
 *
 * Example with additional replacements:
 * @code
 *   $output = format_plural($update_count,
 *     'Changed the content type of 1 post from %old-type to %new-type.',
 *     'Changed the content type of @count posts from %old-type to %new-type.',
765
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
766 767
 * @endcode
 *
768 769 770
 * @param $count
 *   The item count to display.
 * @param $singular
771 772 773
 *   The string for the singular case. Make sure it is clear this is singular,
 *   to ease translation (e.g. use "1 new comment" instead of "1 new"). Do not
 *   use @count in the singular string.
774
 * @param $plural
775 776 777
 *   The string for the plural case. Make sure it is clear this is plural, to
 *   ease translation. Use @count in place of the item count, as in
 *   "@count new comments".
778
 * @param $args
779
 *   An associative array of replacements to make after translation. Instances
780
 *   of any key in this array are replaced with the corresponding value.
781 782 783
 *   Based on the first character of the key, the value is escaped and/or
 *   themed. See format_string(). Note that you do not need to include @count
 *   in this array; this replacement is done automatically for the plural case.
784
 * @param $options
785 786
 *   An associative array of additional options. See t() for allowed keys.
 *
787 788
 * @return
 *   A translated string.
789 790 791
 *
 * @see t()
 * @see format_string()
792
 * @see \Drupal\Core\StringTranslation\TranslationManager->formatPlural()
793
 *
794 795
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::translation()->formatPlural().
796
 */
797
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
798
  return \Drupal::translation()->formatPlural($count, $singular, $plural, $args, $options);
Dries's avatar
Dries committed
799 800
}

801
/**
802
 * Parses a given byte count.
803 804
 *
 * @param $size
805 806
 *   A size expressed as a number of bytes with optional SI or IEC binary unit
 *   prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8 bytes, 9mbytes).
807
 *
808
 * @return
809
 *   An integer representation of the size in bytes.
810 811
 */
function parse_size($size) {
812 813 814 815 816 817 818 819
  $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
  $size = preg_replace('/[^0-9\.]/', '', $size); // Remove the non-numeric characters from the size.
  if ($unit) {
    // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
    return round($size * pow(DRUPAL_KILOBYTE, stripos('bkmgtpezy', $unit[0])));
  }
  else {
    return round($size);
820 821 822
  }
}

823
/**
824
 * Generates a string representation for the given byte count.
825
 *
826
 * @param $size
827
 *   A size in bytes.
828
 * @param $langcode
829 830
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
831
 *
832 833
 * @return
 *   A translated string representation of the size.
834
 */
835
function format_size($size, $langcode = NULL) {
836
  if ($size < DRUPAL_KILOBYTE) {
837
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
Dries committed
838
  }
839
  else {
840
    $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
841
    $units = array(
842 843 844 845 846 847 848 849
      t('@size KB', array(), array('langcode' => $langcode)),
      t('@size MB', array(), array('langcode' => $langcode)),
      t('@size GB', array(), array('langcode' => $langcode)),
      t('@size TB', array(), array('langcode' => $langcode)),
      t('@size PB', array(), array('langcode' => $langcode)),
      t('@size EB', array(), array('langcode' => $langcode)),
      t('@size ZB', array(), array('langcode' => $langcode)),
      t('@size YB', array(), array('langcode' => $langcode)),
850 851
    );
    foreach ($units as $unit) {
852 853
      if (round($size, 2) >= DRUPAL_KILOBYTE) {
        $size = $size / DRUPAL_KILOBYTE;
854 855 856 857
      }
      else {
        break;
      }
858
    }
859
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
Dries committed
860 861 862
  }
}

863
/**
864
 * Formats a time interval with the requested granularity.
865
 *
866
 * @param $interval
867 868 869
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
870 871 872
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
873
 *
874 875
 * @return
 *   A translated string representation of the interval.
876
 *
877 878 879 880
 * @see \Drupal\Core\Datetime\Date::formatInterval()
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('date')->formatInterval().
881
 */
882
function format_interval($interval, $granularity = 2, $langcode = NULL) {
883
  return \Drupal::service('date')->formatInterval($interval, $granularity, $langcode);
Dries's avatar
Dries committed
884 885
}

886
/**
887
 * Formats a date, using a date type or a custom date format string.
888
 *
889
 * @param $timestamp
890
 *   A UNIX timestamp to format.
891
 * @param $type
892
 *   (optional) The format to use, one of:
893 894 895 896 897
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
 *   - The name of a date type defined by a module in
 *     hook_date_format_types(), if it's been assigned a format.
898 899 900
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
901
 * @param $format
902 903 904
 *   (optional) If $type is 'custom', a PHP date format string suitable for
 *   input to date(). Use a backslash to escape ordinary text, so it does not
 *   get interpreted as date format characters.
905
 * @param $timezone
906
 *   (optional) Time zone identifier, as described at
907
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
908
 *   display the page.
909
 * @param $langcode
910 911 912
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
913 914
 * @return
 *   A translated date string in the requested format.
915 916
 *
 * @see \Drupal\Component\Datetime\Date::format()
917
 */
918
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
919
  return \Drupal::service('date')->format($timestamp, $type, $format, $timezone, $langcode);
920 921
}

922 923 924 925 926
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
927
 *
928 929 930 931 932 933 934 935 936
 * @return string
 *   An ISO8601 formatted date.
 */
function date_iso8601($date) {
  // The DATE_ISO8601 constant cannot be used here because it does not match
  // date('c') and produces invalid RDF markup.
  return date('c', $date);
}

937
/**
938 939 940
 * Translates a formatted date string.
 *
 * Callback for preg_replace_callback() within format_date().
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
 */
function _format_date_callback(array $matches = NULL, $new_langcode = NULL) {
  // We cache translations to avoid redundant and rather costly calls to t().
  static $cache, $langcode;

  if (!isset($matches)) {
    $langcode = $new_langcode;
    return;
  }

  $code = $matches[1];
  $string = $matches[2];

  if (!isset($cache[$langcode][$code][$string])) {
    $options = array(
      'langcode' => $langcode,
    );

    if ($code == 'F') {
      $options['context'] = 'Long month name';
961
    }
962