common.inc 193 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\Url;
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\Routing\GeneratorNotInitializedException;
22
use Drupal\Core\SystemListingInfo;
23
use Drupal\Core\Template\Attribute;
24
use Drupal\Core\Render\Element;
25

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 101 102 103 104 105 106 107 108 109 110 111 112 113
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;

/**
 * The default weight for CSS rules that style design components (and their associated states and skins.)
 */
const CSS_COMPONENT = 0;

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

/**
 * The default weight for CSS rules that style skins and are not included with components.
 */
const CSS_SKIN = 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
 * @defgroup block_caching Block Caching
 * @{
 * Constants that define each block's caching state.
139
 *
140 141 142 143 144 145 146 147 148 149
 * Modules specify how their blocks can be cached in their hook_block_info()
 * implementations. Caching can be turned off (DRUPAL_NO_CACHE), managed by the
 * module declaring the block (DRUPAL_CACHE_CUSTOM), or managed by the core
 * Block module. If the Block module is managing the cache, you can specify that
 * the block is the same for every page and user (DRUPAL_CACHE_GLOBAL), or that
 * it can change depending on the page (DRUPAL_CACHE_PER_PAGE) or by user
 * (DRUPAL_CACHE_PER_ROLE or DRUPAL_CACHE_PER_USER). Page and user settings can
 * be combined with a bitwise-binary or operator; for example,
 * DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE means that the block can change
 * depending on the user role or page it is on.
150
 *
151 152
 * The block cache is cleared when the 'content' cache tag is invalidated,
 * following the same pattern as the page cache (node, comment, user, taxonomy
153
 * added or updated...).
154 155 156 157 158
 *
 * Note that user 1 is excluded from block caching.
 */

/**
159 160 161 162 163 164 165
 * The block should not get cached.
 *
 * This setting should be used:
 * - For simple blocks (notably those that do not perform any db query), where
 *   querying the db cache would be more expensive than directly generating the
 *   content.
 * - For blocks that change too frequently.
166
 */
167
const DRUPAL_NO_CACHE = -1;
168 169

/**
170 171
 * The block is handling its own caching in its hook_block_view().
 *
172 173
 * This setting is useful when time based expiration is needed or a site uses a
 * node access which invalidates standard block cache.
174
 */
175
const DRUPAL_CACHE_CUSTOM = -2;
176 177

/**
178 179 180 181
 * The block or element can change depending on the user's roles.
 *
 * This is the default setting for blocks, used when the block does not specify
 * anything.
182
 */
183
const DRUPAL_CACHE_PER_ROLE = 0x0001;
184 185

/**
186 187
 * The block or element can change depending on the user.
 *
188 189 190
 * This setting can be resource-consuming for sites with large number of users,
 * and thus should only be used when DRUPAL_CACHE_PER_ROLE is not sufficient.
 */
191
const DRUPAL_CACHE_PER_USER = 0x0002;
192 193 194 195

/**
 * The block or element can change depending on the page being viewed.
 */
196
const DRUPAL_CACHE_PER_PAGE = 0x0004;
197 198

/**
199
 * The block or element is the same for every user and page that it is visible.
200
 */
201
const DRUPAL_CACHE_GLOBAL = 0x0008;
202

203 204 205 206
/**
 * @} End of "defgroup block_caching".
 */

207 208 209 210 211 212 213 214 215
/**
 * 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";

216
/**
217
 * Adds content to a specified region.
218 219
 *
 * @param $region
220
 *   Page region the content is added to.
221
 * @param $data
222
 *   Content to be added.
223
 */
224
function drupal_add_region_content($region = NULL, $data = NULL) {
225 226
  static $content = array();

227
  if (isset($region) && isset($data)) {
228 229 230 231 232 233
    $content[$region][] = $data;
  }
  return $content;
}

/**
234
 * Gets assigned content for a given region.
235 236
 *
 * @param $region
237 238
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
239
 * @param $delimiter
240
 *   Content to be inserted between imploded array elements.
241
 */
242 243
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
244 245
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
246
      return implode($delimiter, $content[$region]);
247
    }
248 249 250 251
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
252
        $content[$region] = implode($delimiter, $content[$region]);
253 254 255 256 257 258
      }
    }
    return $content;
  }
}

259
/**
260
 * Gets the name of the currently active installation profile.
261 262 263
 *
 * 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
264 265
 * installation state. At all other times, the "install_profile" setting will be
 * available in settings.php.
266 267
 *
 * @return $profile
268
 *   The name of the installation profile.
269 270 271 272
 */
function drupal_get_profile() {
  global $install_state;

273 274 275 276 277 278 279 280
  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 = '';
    }
281 282
  }
  else {
283
    $profile = settings()->get('install_profile') ?: 'standard';
284 285 286 287 288
  }

  return $profile;
}

Dries's avatar
Dries committed
289
/**
290
 * Adds output to the HEAD tag of the HTML page.
291
 *
292
 * This function can be called as long as the headers aren't sent. Pass no
293 294 295 296 297 298 299 300 301 302 303 304
 * 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.
 *
305
 * @see drupal_pre_render_html_tag()
Dries's avatar
Dries committed
306
 */
307 308
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
309

310 311 312 313 314 315 316 317 318 319
  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
320 321 322 323
  }
  return $stored_head;
}

324
/**
325 326 327 328 329 330 331 332 333 334
 * 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(
335
      'charset' => 'utf-8',
336 337 338 339 340 341
    ),
    // 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.
342
  list($version, ) = explode('.', \Drupal::VERSION);
343 344 345 346 347 348 349 350 351 352 353 354 355 356
  $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;
}

/**
357
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
358
  */
Dries's avatar
Dries committed
359
function drupal_get_html_head() {
360
  $elements = drupal_add_html_head();
361
  \Drupal::moduleHandler()->alter('html_head', $elements);
362
  return drupal_render($elements);
Dries's avatar
Dries committed
363 364
}

365
/**
366
 * Adds a feed URL for the current page.
367
 *
368 369
 * This function can be called as long the HTML header hasn't been sent.
 *
370
 * @param $url
371
 *   An internal system path or a fully qualified external URL of the feed.
372
 * @param $title
373
 *   The title of the feed.
374
 */
375
function drupal_add_feed($url = NULL, $title = '') {
376
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
377

378
  if (isset($url)) {
379 380 381 382 383
    $feed_icon = array(
      '#theme' => 'feed_icon',
      '#url' => $url,
      '#title' => $title,
    );
384

385
    $feed_icon['#attached']['drupal_add_html_head_link'][][] = array(
386 387 388 389 390 391
      '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)),
392
    );
393 394

    $stored_feed_links[$url] = drupal_render($feed_icon);
395 396 397 398 399
  }
  return $stored_feed_links;
}

/**
400
 * Gets the feed URLs for the current page.
401 402
 *
 * @param $delimiter
403
 *   A delimiter to split feeds by.
404 405 406 407 408 409
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

410
/**
411
 * @defgroup http_handling HTTP handling
412
 * @{
413
 * Functions to properly handle HTTP responses.
414 415
 */

416
/**
417
 * Processes a URL query parameter array to remove unwanted elements.
418 419
 *
 * @param $query
420 421
 *   (optional) An array to be processed. Defaults to \Drupal::request()->query
 *   parameters.
422
 * @param $exclude
423
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
424
 *   exclude nested items.
425
 * @param $parent
426 427
 *   Internal use only. Used to build the $query array key for nested items.
 *
428
 * @return
429
 *   An array containing query parameters, which can be used for url().
430
 *
431 432
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\Component\Utility\Url::filterQueryParameters().
433
 */
434
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
435
  if (!isset($query)) {
436
    $query = \Drupal::request()->query->all();
437
  }
438
  return Url::filterQueryParameters($query, $exclude, $parent);
439 440
}

441
/**
442
 * Parses an array into a valid, rawurlencoded query string.
443 444 445
 *
 * @see drupal_get_query_parameters()
 * @ingroup php_wrappers
446
 *
447 448
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\Component\Utility\Url::buildQuery().
449 450
 */
function drupal_http_build_query(array $query, $parent = '') {
451
  return Url::buildQuery($query, $parent);
452 453
}

454
/**
455
 * Prepares a 'destination' URL query parameter for use with url().
456
 *
457 458 459 460
 * 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.
461
 *
462 463 464 465 466 467
 * @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()
468 469
 */
function drupal_get_destination() {
470 471 472 473 474 475
  $destination = &drupal_static(__FUNCTION__);

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

476
  $query = \Drupal::request()->query;
477 478
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
479 480
  }
  else {
481
    $path = current_path();
482
    $query = Url::buildQuery(Url::filterQueryParameters($query->all()));
483
    if ($query != '') {
484
      $path .= '?' . $query;
485
    }
486 487 488 489 490 491
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
492
 * Parses a system URL string into an associative array suitable for url().
493 494
 *
 * This function should only be used for URLs that have been generated by the
495 496
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
497 498 499 500
 *
 * The returned array contains a 'path' that may be passed separately to url().
 * For example:
 * @code
501
 *   $options = drupal_parse_url(\Drupal::request()->query->get('destination'));
502 503 504 505 506 507 508 509 510 511
 *   $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
512
 *   The URL string to parse.
513 514 515 516 517 518 519 520 521 522
 *
 * @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
523
 *
524 525
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\Component\Utility\Url::parse().
526 527
 */
function drupal_parse_url($url) {
528
  return Url::parse($url);
529 530 531
}

/**
532
 * Encodes a Drupal path for use in a URL.
533
 *
534
 * For aesthetic reasons slashes are not escaped.
535
 *
536 537
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
538 539
 *
 * @param $path
540
 *   The Drupal path to encode.
541
 *
542 543
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\Component\Utility\Url::encodePath().
544 545
 */
function drupal_encode_path($path) {
546
  return Url::encodePath($path);
547 548
}

549 550 551 552 553 554 555 556
/**
 * 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.
557
 *
558 559
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\Component\Utility\Url::externalIsLocal().
560 561
 */
function _external_url_is_local($url) {
562
  return Url::externalIsLocal($url, base_path());
563 564
}

565 566 567 568 569 570 571
/**
 * 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) {
572
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
573 574 575
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

576
/**
577
 * @} End of "defgroup http_handling".
578
 */
579

580
/**
581
 * @defgroup validation Input validation
582
 * @{
583
 * Functions to validate user input.
584 585
 */

586
/**
587
 * Verifies the syntax of the given e-mail address.
588
 *
589 590
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
591
 *
592
 * @param $mail
593
 *   A string containing an e-mail address.
594
 *
595
 * @return
596
 *   TRUE if the address is in a valid format.
597
 */
598
function valid_email_address($mail) {
599
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
600 601
}

602
/**
603
 * Verifies the syntax of the given URL.
604
 *
605 606
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
607
 * Valid values per RFC 3986.
608
 * @param $url
609
 *   The URL to verify.
610
 * @param $absolute
611
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
612
 *
613
 * @return
614
 *   TRUE if the URL is in a valid format.
615
 *
616
 * @see \Drupal\Component\Utility\Url::isValid()
617
 *
618 619
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\Component\Utility\Url::isValid().
620
 */
621
function valid_url($url, $absolute = FALSE) {
622
  return Url::isValid($url, $absolute);
623 624
}

625 626 627 628
/**
 * @} End of "defgroup validation".
 */

629 630 631 632
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
633 634 635
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
636 637
 */

638
/**
639
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
640 641 642 643 644 645 646
 *
 * @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
647 648 649
 *   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
650 651
 *   Drupal\Core\Template\Attribute, call
 *   \Drupal\Component\Utility\Url::stripDangerousProtocols() instead.
652
 *
653 654
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
655 656
 */
function check_url($uri) {
657
  return String::checkPlain(Url::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
658 659
}

660
/**
661
 * Applies a very permissive XSS/HTML filter for admin-only use.
662 663 664
 *
 * Use only for fields where it is impractical to use the
 * whole filter system, but where some (mainly inline) mark-up
665 666
 * is desired (so \Drupal\Component\Utility\String::checkPlain() is not
 * acceptable).
667 668 669
 *
 * Allows all tags that can be used inside an HTML body, save
 * for scripts and styles.
670 671 672 673 674 675 676 677
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
678 679
 */
function filter_xss_admin($string) {
680
  return Xss::filterAdmin($string);
681 682 683
}

/**
684
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
685
 *
686 687
 * 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.
688 689
 *
 * This code does four things:
690 691 692 693 694
 * - 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:).
695 696
 *
 * @param $string
697 698
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
699 700
 * @param $allowed_tags
 *   An array of allowed tags.
701 702 703 704 705
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
706 707
 * @see \Drupal\Component\Utility\Xss::filter()
 *
708
 * @ingroup sanitization
709 710
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
711
  return Xss::filter($string, $allowed_tags);
712 713 714
}

/**
715
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
716
 *
717
 * @param string $string
718
 *   The string with the attribute value.
719
 *
720
 * @return string
721
 *   Cleaned up and HTML-escaped version of $string.
722 723
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
724
 */
725
function filter_xss_bad_protocol($string) {
726
  return Url::filterBadProtocol($string);
727 728 729 730 731 732
}

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

733
/**
734
 * @defgroup format Formatting
735
 * @{
736
 * Functions to format numbers, strings, dates, etc.
737 738
 */

739 740 741 742 743
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
744
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
745
  $langcode = $langcode ? $langcode : \Drupal::languageManager()->getCurrentLanguage(Language::TYPE_CONTENT)->id;
Dries's avatar
Dries committed
746

Dries's avatar
Dries committed
747
  $output = "<channel>\n";
748
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
749
  $output .= ' <link>' . check_url($link) . "</link>\n";
750 751 752 753

  // 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;).
754 755
  $output .= ' <description>' . String::checkPlain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . String::checkPlain($langcode) . "</language>\n";
756
  $output .= format_xml_elements($args);
Dries's avatar
Dries committed
757 758 759 760 761 762
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

763
/**
764
 * Formats a single RSS item.
765 766 767
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
Dries committed
768
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
769
  $output = "<item>\n";
770
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
771
  $output .= ' <link>' . check_url($link) . "</link>\n";
772
  $output .= ' <description>' . String::checkPlain($description) . "</description>\n";
773 774 775 776 777 778 779
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
780
 * Formats XML elements.
781 782
 *
 * @param $array
783
 *   An array where each item represents an element and is either a:
784 785 786 787 788 789 790 791 792 793
 *   - (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) {
794
  $output = '';
795 796
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
797
      if ($value['key']) {
798
        $output .= ' <' . $value['key'];
799
        if (isset($value['attributes']) && is_array($value['attributes'])) {
800
          $output .= new Attribute($value['attributes']);
801 802
        }

803
        if (isset($value['value']) && $value['value'] != '') {
804
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
805 806 807 808 809 810 811
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
812
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
813
    }
Dries's avatar
Dries committed
814
  }
Dries's avatar
Dries committed
815 816 817
  return $output;
}

818
/**
819
 * Formats a string containing a count of items.
820
 *
821
 * This function ensures that the string is pluralized correctly. Since t() is
822 823
 * called by this function, make sure not to pass already-localized strings to
 * it.
824
 *
825 826 827 828 829 830 831 832 833 834
 * 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.',
835
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
836 837
 * @endcode
 *
838 839 840
 * @param $count
 *   The item count to display.
 * @param $singular
841 842 843
 *   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.
844
 * @param $plural
845 846 847
 *   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".
848
 * @param $args
849
 *   An associative array of replacements to make after translation. Instances
850
 *   of any key in this array are replaced with the corresponding value.
851 852 853
 *   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.
854
 * @param $options
855 856
 *   An associative array of additional options. See t() for allowed keys.
 *
857 858
 * @return
 *   A translated string.
859 860 861
 *
 * @see t()
 * @see format_string()
862
 * @see \Drupal\Core\StringTranslation\TranslationManager->formatPlural()
863
 *
864 865
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::translation()->formatPlural().
866
 */
867
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
868
  return \Drupal::translation()->formatPlural($count, $singular, $plural, $args, $options);
Dries's avatar
Dries committed
869 870
}

871
/**
872
 * Parses a given byte count.
873 874
 *
 * @param $size
875 876
 *   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).
877
 *
878
 * @return
879
 *   An integer representation of the size in bytes.
880 881
 */
function parse_size($size) {
882 883 884 885 886 887 888 889
  $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);
890 891 892
  }
}

893
/**
894
 * Generates a string representation for the given byte count.
895
 *
896
 * @param $size
897
 *   A size in bytes.
898
 * @param $langcode
899 900
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
901
 *
902 903
 * @return
 *   A translated string representation of the size.
904
 */
905
function format_size($size, $langcode = NULL) {
906
  if ($size < DRUPAL_KILOBYTE) {
907
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
Dries committed
908
  }
909
  else {
910
    $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
911
    $units = array(
912 913 914 915 916 917 918 919
      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)),
920 921
    );
    foreach ($units as $unit) {
922 923
      if (round($size, 2) >= DRUPAL_KILOBYTE) {
        $size = $size / DRUPAL_KILOBYTE;
924 925 926 927
      }
      else {
        break;
      }
928
    }
929
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
Dries committed
930 931 932
  }
}

933
/**
934
 * Formats a time interval with the requested granularity.
935
 *
936
 * @param $interval
937 938 939
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
940 941 942
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
943
 *
944 945
 * @return
 *   A translated string representation of the interval.
946
 *
947 948 949 950
 * @see \Drupal\Core\Datetime\Date::formatInterval()
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('date')->formatInterval().
951
 */
952
function format_interval($interval, $granularity = 2, $langcode = NULL) {
953
  return \Drupal::service('date')->formatInterval($interval, $granularity, $langcode);
Dries's avatar
Dries committed
954 955
}

956
/**
957
 * Formats a date, using a date type or a custom date format string.
958
 *
959
 * @param $timestamp
960
 *   A UNIX timestamp to format.
961
 * @param $type
962
 *   (optional) The format to use, one of:
963 964 965 966 967
 *   - 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.
968 969 970
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
971
 * @param $format
972 973 974
 *   (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.
975
 * @param $timezone
976
 *   (optional) Time zone identifier, as described at