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

3
use Drupal\Component\Utility\Crypt;
4
use Drupal\Component\Utility\Json;
5
use Drupal\Component\Utility\Number;
6
use Drupal\Component\Utility\Settings;
7
use Drupal\Component\Utility\SortArray;
8
use Drupal\Component\Utility\String;
9
use Drupal\Component\Utility\Tags;
10
use Drupal\Component\Utility\UrlHelper;
11
use Drupal\Component\Utility\Xss;
12
use Drupal\Core\Cache\Cache;
13
use Drupal\Core\Language\Language;
14 15
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
16 17
use Symfony\Component\Yaml\Parser;
use Symfony\Component\Yaml\Exception\ParseException;
18
use Drupal\Component\PhpStorage\PhpStorageFactory;
19
use Drupal\Component\Utility\NestedArray;
20
use Drupal\Core\Datetime\DrupalDateTime;
21
use Drupal\Core\EventSubscriber\HtmlViewSubscriber;
22
use Drupal\Core\Routing\GeneratorNotInitializedException;
23
use Drupal\Core\Template\Attribute;
24
use Drupal\Core\Render\Element;
25

Dries's avatar
 
Dries committed
26 27 28 29 30 31 32 33
/**
 * @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.
 */

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
/**
 * @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
 *
62
 * @}
63 64
 */

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

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

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

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

/**
86
 * The default aggregation group for theme CSS files added to the page.
87
 */
88 89 90 91 92 93 94 95 96 97 98 99 100
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;

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

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

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

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

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

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

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

135 136 137 138 139 140 141 142 143
/**
 * 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";

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

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

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

187
/**
188
 * Gets the name of the currently active installation profile.
189 190 191
 *
 * 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
192 193
 * installation state. At all other times, the "install_profile" setting will be
 * available in settings.php.
194 195
 *
 * @return $profile
196
 *   The name of the installation profile.
197 198 199 200
 */
function drupal_get_profile() {
  global $install_state;

201 202 203 204 205 206 207 208
  if (drupal_installation_attempted()) {
    // If the profile has been selected return it.
    if (isset($install_state['parameters']['profile'])) {
      $profile = $install_state['parameters']['profile'];
    }
    else {
      $profile = '';
    }
209 210
  }
  else {
211
    $profile = Settings::get('install_profile') ?: 'standard';
212 213 214 215 216
  }

  return $profile;
}

Dries's avatar
Dries committed
217
/**
218
 * Adds output to the HEAD tag of the HTML page.
219
 *
220
 * This function can be called as long as the headers aren't sent. Pass no
221 222 223 224 225 226 227 228 229 230 231 232
 * 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.
 *
233
 * @see drupal_pre_render_html_tag()
Dries's avatar
Dries committed
234
 */
235 236
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
237

238 239 240 241 242 243 244 245 246 247
  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
248 249 250 251
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
252
/**
253 254 255 256 257 258 259 260 261 262
 * 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(
263
      'charset' => 'utf-8',
264 265 266 267 268 269
    ),
    // 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.
270
  list($version, ) = explode('.', \Drupal::VERSION);
271 272 273 274 275 276 277 278 279 280 281 282 283 284
  $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;
}

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

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

306
  if (isset($url)) {
307 308 309 310 311
    $feed_icon = array(
      '#theme' => 'feed_icon',
      '#url' => $url,
      '#title' => $title,
    );
312

313
    $feed_icon['#attached']['drupal_add_html_head_link'][][] = array(
314 315 316 317 318 319
      '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)),
320
    );
321 322

    $stored_feed_links[$url] = drupal_render($feed_icon);
323 324 325 326 327
  }
  return $stored_feed_links;
}

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

Dries's avatar
 
Dries committed
338
/**
339
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
340
 * @{
Dries's avatar
 
Dries committed
341
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
342 343
 */

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

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

382
/**
383
 * Prepares a 'destination' URL query parameter for use with url().
384
 *
385 386 387 388
 * 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.
389
 *
390 391 392 393 394 395
 * @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()
396 397
 */
function drupal_get_destination() {
398 399 400 401 402 403
  $destination = &drupal_static(__FUNCTION__);

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

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

/**
420
 * Parses a system URL string into an associative array suitable for url().
421 422
 *
 * This function should only be used for URLs that have been generated by the
423 424
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
425 426 427 428
 *
 * The returned array contains a 'path' that may be passed separately to url().
 * For example:
 * @code
429
 *   $options = drupal_parse_url(\Drupal::request()->query->get('destination'));
430 431 432 433 434 435 436 437 438 439
 *   $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
440
 *   The URL string to parse.
441 442 443 444 445 446 447 448 449 450
 *
 * @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
451
 *
452
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
453
 *   Use \Drupal\Component\Utility\UrlHelper::parse().
454 455
 */
function drupal_parse_url($url) {
456
  return UrlHelper::parse($url);
457 458 459
}

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

477 478 479 480 481 482 483 484
/**
 * 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.
485
 *
486
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
487
 *   Use \Drupal\Component\Utility\UrlHelper::externalIsLocal().
488 489
 */
function _external_url_is_local($url) {
490
  return UrlHelper::externalIsLocal($url, base_path());
491 492
}

493 494 495 496 497 498 499
/**
 * 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) {
500
  $proxy_exceptions = Settings::get('proxy_exceptions', array('localhost', '127.0.0.1'));
501 502 503
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
 
Dries committed
504
/**
505
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
506
 */
Dries's avatar
 
Dries committed
507

Kjartan's avatar
Kjartan committed
508
/**
Dries's avatar
 
Dries committed
509
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
510
 * @{
Dries's avatar
 
Dries committed
511
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
512 513
 */

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

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

553 554 555 556
/**
 * @} End of "defgroup validation".
 */

557 558 559 560
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
561 562 563
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
564 565
 */

566
/**
567
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
568 569 570 571 572 573 574
 *
 * @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
575 576 577
 *   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
578
 *   Drupal\Core\Template\Attribute, call
579
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
580
 *
581
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
582
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
583 584
 */
function check_url($uri) {
585
  return String::checkPlain(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
586 587
}

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

/**
612
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
613
 *
614 615
 * 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.
616 617
 *
 * This code does four things:
618 619 620 621 622
 * - 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:).
623 624
 *
 * @param $string
625 626
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
627 628
 * @param $allowed_tags
 *   An array of allowed tags.
629 630 631 632 633
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
634
 * @see \Drupal\Component\Utility\Xss::filter()
635 636
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
637
  return Xss::filter($string, $allowed_tags);
638 639 640
}

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

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

Dries's avatar
 
Dries committed
659
/**
Dries's avatar
 
Dries committed
660
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
661
 * @{
Dries's avatar
 
Dries committed
662
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
663 664
 */

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

Dries's avatar
Dries committed
673
  $output = "<channel>\n";
674
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
675
  $output .= ' <link>' . check_url($link) . "</link>\n";
676 677 678 679

  // 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;).
680 681
  $output .= ' <description>' . String::checkPlain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . String::checkPlain($langcode) . "</language>\n";
682
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
683 684 685 686 687 688
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

  return $output;
}

/**
706
 * Formats XML elements.
707 708
 *
 * @param $array
709
 *   An array where each item represents an element and is either a:
710 711 712 713 714 715 716 717 718 719
 *   - (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) {
720
  $output = '';
721 722
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
723
      if ($value['key']) {
724
        $output .= ' <' . $value['key'];
725
        if (isset($value['attributes']) && is_array($value['attributes'])) {
726
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
727 728
        }

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

Dries's avatar
 
Dries committed
744
/**
745
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
746
 *
Dries's avatar
 
Dries committed
747
 * This function ensures that the string is pluralized correctly. Since t() is
748 749
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
750
 *
751 752 753 754 755 756 757 758 759 760
 * 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.',
761
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
762 763
 * @endcode
 *
Dries's avatar
 
Dries committed
764 765 766
 * @param $count
 *   The item count to display.
 * @param $singular
767 768 769
 *   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.
Dries's avatar
 
Dries committed
770
 * @param $plural
771 772 773
 *   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".
774
 * @param $args
775
 *   An associative array of replacements to make after translation. Instances
776
 *   of any key in this array are replaced with the corresponding value.
777 778 779
 *   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.
780
 * @param $options
781 782
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
783 784
 * @return
 *   A translated string.
785 786 787
 *
 * @see t()
 * @see format_string()
788
 * @see \Drupal\Core\StringTranslation\TranslationManager->formatPlural()
789
 *
790 791
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::translation()->formatPlural().
Dries's avatar
 
Dries committed
792
 */
793
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
794
  return \Drupal::translation()->formatPlural($count, $singular, $plural, $args, $options);
Dries's avatar
 
Dries committed
795 796
}

797
/**
798
 * Parses a given byte count.
799 800
 *
 * @param $size
801 802
 *   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).
803
 *
804
 * @return
805
 *   An integer representation of the size in bytes.
806 807
 */
function parse_size($size) {
808 809 810 811 812 813 814 815
  $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);
816 817 818
  }
}

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

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

Dries's avatar
 
Dries committed
882
/**
883
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
884
 *
Dries's avatar
 
Dries committed
885
 * @param $timestamp
886
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
887
 * @param $type
888
 *   (optional) The format to use, one of:
889 890 891 892 893
 *   - 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.
894 895 896
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
897
 * @param $format
898 899 900
 *   (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.
Dries's avatar
 
Dries committed
901
 * @param $timezone
902
 *   (optional) Time zone identifier, as described at
903
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
904
 *   display the page.
905
 * @param $langcode
906 907 908
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
909 910
 * @return
 *   A translated date string in the requested format.
911 912
 *
 * @see \Drupal\Component\Datetime\Date::format()
Dries's avatar
 
Dries committed
913
 */
914
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
915
  return \Drupal::service('date')->format($timestamp, $type, $format, $timezone, $langcode);
916 917
}

918 919 920 921 922
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
923
 *
924 925 926 927 928 929 930 931 932
 * @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);
}

933
/**
934 935 936
 * Translates a formatted date string.
 *
 * Callback for preg_replace_callback() within format_date().
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
 */
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';
Dries's avatar
 
Dries committed
957
    }
958 959 960

    if ($code == '') {
      $cache[$langcode][$code][$string] = $string;
961
    }
Dries's avatar
 
Dries committed
962
    else {
963
      $cache[$langcode][$code][$string] = t($string, array(), $options);
Dries's avatar
 
Dries committed
964
    }
Dries's avatar
 
Dries committed
965
  }
966
  return $cache[$langcode][$code][$string];
Dries's avatar
 
Dries committed
967 968
}

969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
/**
 * Retrieves the correct datetime format type for this system.
 *
 * This value is sometimes required when the format type needs to be determined
 * before a date can be created.
 *
 * @return string
 *   A string as defined in \DrupalComponent\Datetime\DateTimePlus.php: either
 *   'intl' or 'php', depending on whether IntlDateFormatter is available.
 */
function datetime_default_format_type() {
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['format_type'] = &drupal_static(__FUNCTION__);
  }
  $format_type = &$drupal_static_fast['format_type'];

  if (!isset($format_type)) {
    $date = new DrupalDateTime();
    $format_type = $date->canUseIntl() ? DrupalDateTime::INTL : DrupalDateTime::PHP;
  }
  return $format_type;
}

Dries's avatar
 
Dries committed
993 994 995
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
996

Dries's avatar
 
Dries committed
997
/**
998 999 1000 1001
 * Generates an internal or external URL.
 *
 * When creating links in modules, consider whether l() could be a better
 * alternative than url().
Dries's avatar
 
Dries committed
1002
 *
1003
 * @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromPath().
Dries's avatar
 
Dries committed
1004
 */
1005
function url($path = NULL, array $options = array()) {
1006
  $generator = \Drupal::urlGenerator();
1007 1008
  try {
    $url = $generator->generateFromPath($path, $options);
1009
  }
1010 1011 1012 1013 1014 1015 1016 1017 1018