common.inc 181 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
use Symfony\Component\Yaml\Parser;
15 16
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
17
use Drupal\Component\PhpStorage\PhpStorageFactory;
18
use Drupal\Component\Utility\MapArray;
19
use Drupal\Component\Utility\NestedArray;
20
use Drupal\Core\Cache\CacheBackendInterface;
21
use Drupal\Core\Datetime\DrupalDateTime;
22
use Drupal\Core\Routing\GeneratorNotInitializedException;
23
use Drupal\Core\SystemListingInfo;
24
use Drupal\Core\Template\Attribute;
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 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 289
  }

  return $profile;
}


Dries's avatar
 
Dries committed
290
/**
291
 * Sets the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
292
 *
Dries's avatar
 
Dries committed
293 294 295
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
296 297 298 299
 *
 * @deprecated This will be removed in 8.0. Instead, register a new breadcrumb
 *   builder service.
 *
300
 * @see \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface
Kjartan's avatar
Kjartan committed
301
 */
Dries's avatar
 
Dries committed
302
function drupal_set_breadcrumb($breadcrumb = NULL) {
303
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
 
Dries committed
304

305
  if (isset($breadcrumb)) {
Dries's avatar
 
Dries committed
306 307 308 309 310
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
Dries committed
311
/**
312
 * Adds output to the HEAD tag of the HTML page.
313
 *
314
 * This function can be called as long as the headers aren't sent. Pass no
315 316 317 318 319 320 321 322 323 324 325 326
 * 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.
 *
327
 * @see drupal_pre_render_html_tag()
Dries's avatar
Dries committed
328
 */
329 330
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
331

332 333 334 335 336 337 338 339 340 341
  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
342 343 344 345
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
346
/**
347 348 349 350 351 352 353 354 355 356
 * 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(
357
      'charset' => 'utf-8',
358 359 360 361 362 363
    ),
    // 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.
364
  list($version, ) = explode('.', \Drupal::VERSION);
365 366 367 368 369 370 371 372 373 374 375 376 377 378
  $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;
}

/**
379
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
Dries's avatar
 
Dries committed
380
 */
Dries's avatar
Dries committed
381
function drupal_get_html_head() {
382 383 384
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
385 386
}

387
/**
388
 * Adds a feed URL for the current page.
389
 *
390 391
 * This function can be called as long the HTML header hasn't been sent.
 *
392
 * @param $url
393
 *   An internal system path or a fully qualified external URL of the feed.
394
 * @param $title
395
 *   The title of the feed.
396
 */
397
function drupal_add_feed($url = NULL, $title = '') {
398
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
399

400
  if (isset($url)) {
401
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
402

403 404 405 406 407 408 409 410
    drupal_add_html_head_link(array(
      '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)),
    ));
411 412 413 414 415
  }
  return $stored_feed_links;
}

/**
416
 * Gets the feed URLs for the current page.
417 418
 *
 * @param $delimiter
419
 *   A delimiter to split feeds by.
420 421 422 423 424 425
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
 
Dries committed
426
/**
427
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
428
 * @{
Dries's avatar
 
Dries committed
429
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
430 431
 */

432
/**
433
 * Processes a URL query parameter array to remove unwanted elements.
434 435
 *
 * @param $query
436
 *   (optional) An array to be processed. Defaults to $_GET.
437
 * @param $exclude
438
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
439
 *   exclude nested items.
440
 * @param $parent
441 442
 *   Internal use only. Used to build the $query array key for nested items.
 *
443
 * @return
444
 *   An array containing query parameters, which can be used for url().
445 446
 *
 * @deprecated as of Drupal 8.0. Use Url::filterQueryParameters() instead.
447
 */
448
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
449
  if (!isset($query)) {
450
    $query = \Drupal::request()->query->all();
451
  }
452
  return Url::filterQueryParameters($query, $exclude, $parent);
453 454
}

455
/**
456
 * Parses an array into a valid, rawurlencoded query string.
457 458
 *
 * @see drupal_get_query_parameters()
459
 * @deprecated as of Drupal 8.0. Use Url::buildQuery() instead.
460
 * @ingroup php_wrappers
461 462
 *
 * @deprecated as of Drupal 8.0. Use Url::buildQuery() instead.
463 464
 */
function drupal_http_build_query(array $query, $parent = '') {
465
  return Url::buildQuery($query, $parent);
466 467
}

468
/**
469
 * Prepares a 'destination' URL query parameter for use with url().
470
 *
471 472 473 474
 * 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.
475
 *
476 477 478 479 480 481
 * @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()
482 483
 */
function drupal_get_destination() {
484 485 486 487 488 489
  $destination = &drupal_static(__FUNCTION__);

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

490
  $query = \Drupal::request()->query;
491 492
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
493 494
  }
  else {
495
    $path = current_path();
496
    $query = Url::buildQuery(Url::filterQueryParameters($query->all()));
497
    if ($query != '') {
498
      $path .= '?' . $query;
499
    }
500 501 502 503 504 505
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
506
 * Parses a system URL string into an associative array suitable for url().
507 508
 *
 * This function should only be used for URLs that have been generated by the
509 510
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
 *
 * The returned array contains a 'path' that may be passed separately to url().
 * For example:
 * @code
 *   $options = drupal_parse_url($_GET['destination']);
 *   $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
 *   The URL string to parse, f.e. $_GET['destination'].
 *
 * @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
537 538
 *
 * @deprecated as of Drupal 8.0. Use Url::parse() instead.
539 540
 */
function drupal_parse_url($url) {
541
  return Url::parse($url);
542 543 544
}

/**
545
 * Encodes a Drupal path for use in a URL.
546
 *
547
 * For aesthetic reasons slashes are not escaped.
548
 *
549 550
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
551 552
 *
 * @param $path
553
 *   The Drupal path to encode.
554 555
 *
 * @deprecated as of Drupal 8.0. Use Url::encodePath() instead.
556 557
 */
function drupal_encode_path($path) {
558
  return Url::encodePath($path);
559 560
}

561 562 563 564 565 566 567 568
/**
 * 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.
569 570
 *
 * @deprecated as of Drupal 8.0. Use Url::externalIsLocal() instead.
571 572
 */
function _external_url_is_local($url) {
573
  return Url::externalIsLocal($url, base_path());
574 575
}

576 577 578 579 580 581 582
/**
 * 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) {
583
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
584 585 586
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
 
Dries committed
587
/**
588
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
589
 */
Dries's avatar
 
Dries committed
590

Kjartan's avatar
Kjartan committed
591
/**
Dries's avatar
 
Dries committed
592
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
593
 * @{
Dries's avatar
 
Dries committed
594
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
595 596
 */

597
/**
598
 * Verifies the syntax of the given e-mail address.
Dries's avatar
 
Dries committed
599
 *
600 601
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
602
 *
Dries's avatar
 
Dries committed
603
 * @param $mail
604
 *   A string containing an e-mail address.
605
 *
Dries's avatar
 
Dries committed
606
 * @return
Dries's avatar
 
Dries committed
607
 *   TRUE if the address is in a valid format.
608
 */
Dries's avatar
 
Dries committed
609
function valid_email_address($mail) {
610
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
611 612
}

Dries's avatar
 
Dries committed
613
/**
614
 * Verifies the syntax of the given URL.
Dries's avatar
 
Dries committed
615
 *
616 617
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
618
 * Valid values per RFC 3986.
Dries's avatar
 
Dries committed
619
 * @param $url
Dries's avatar
 
Dries committed
620
 *   The URL to verify.
Dries's avatar
 
Dries committed
621
 * @param $absolute
Dries's avatar
 
Dries committed
622
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
623
 *
Dries's avatar
 
Dries committed
624
 * @return
Dries's avatar
 
Dries committed
625
 *   TRUE if the URL is in a valid format.
626
 *
627
 * @see \Drupal\Component\Utility\Url::isValid()
628
 *
629
 * @deprecated as of Drupal 8.0. Use Url::isValid() instead.
Dries's avatar
 
Dries committed
630
 */
Dries's avatar
 
Dries committed
631
function valid_url($url, $absolute = FALSE) {
632
  return Url::isValid($url, $absolute);
Dries's avatar
 
Dries committed
633 634
}

635 636 637
/**
 * Verifies that a number is a multiple of a given step.
 *
638
 * @see \Drupal\Component\Utility\Number::validStep()
639
 *
640
 * @param numeric $value
641
 *   The value that needs to be checked.
642
 * @param numeric $step
643
 *   The step scale factor. Must be positive.
644
 * @param numeric $offset
645 646 647 648 649 650
 *   (optional) An offset, to which the difference must be a multiple of the
 *   given step.
 *
 * @return bool
 *   TRUE if no step mismatch has occured, or FALSE otherwise.
 *
651 652
 * @deprecated as of Drupal 8.0. Use
 *   \Drupal\Component\Utility\Number::validStep() directly instead
653 654
 */
function valid_number_step($value, $step, $offset = 0.0) {
655
  return Number::validStep($value, $step, $offset);
656 657
}

658 659 660 661
/**
 * @} End of "defgroup validation".
 */

662 663 664 665
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
666 667 668
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
669 670
 */

Dries's avatar
Dries committed
671
/**
672 673 674 675 676 677
 * Strips dangerous protocols (e.g. 'javascript:') from a URI.
 *
 * This function must be called for all URIs within user-entered input prior
 * to being output to an HTML attribute value. It is often called as part of
 * check_url() or filter_xss(), but those functions return an HTML-encoded
 * string, so this function can be called independently when the output needs to
678 679
 * be a plain-text string for passing to t(), l(),
 * Drupal\Core\Template\Attribute, or another function that will call
680
 * \Drupal\Component\Utility\String::checkPlain() separately.
681 682 683 684 685 686 687
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
 * @return
 *   A plain-text URI stripped of dangerous protocols. As with all plain-text
 *   strings, this return value must not be output to an HTML page without
688 689
 *   \Drupal\Component\Utility\String::checkPlain() being called on it. However,
 *   it can be passed to functions expecting plain-text strings.
690
 *
691
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
692 693
 */
function drupal_strip_dangerous_protocols($uri) {
694
  return Url::stripDangerousProtocols($uri);
695 696 697
}

/**
698
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
699 700 701 702 703 704 705
 *
 * @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
706 707 708
 *   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
709 710
 *   Drupal\Core\Template\Attribute, call
 *   \Drupal\Component\Utility\Url::stripDangerousProtocols() instead.
711
 *
712 713
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
714 715
 */
function check_url($uri) {
716
  return String::checkPlain(Url::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
717 718
}

719
/**
720
 * Applies a very permissive XSS/HTML filter for admin-only use.
721 722 723
 *
 * Use only for fields where it is impractical to use the
 * whole filter system, but where some (mainly inline) mark-up
724 725
 * is desired (so \Drupal\Component\Utility\String::checkPlain() is not
 * acceptable).
726 727 728
 *
 * Allows all tags that can be used inside an HTML body, save
 * for scripts and styles.
729 730 731 732 733 734 735 736
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
737 738
 */
function filter_xss_admin($string) {
739
  return Xss::filterAdmin($string);
740 741 742
}

/**
743
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
744
 *
745 746
 * 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.
747 748
 *
 * This code does four things:
749 750 751 752 753
 * - 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:).
754 755
 *
 * @param $string
756 757
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
758 759
 * @param $allowed_tags
 *   An array of allowed tags.
760 761 762 763 764
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
765 766
 * @see \Drupal\Component\Utility\Xss::filter()
 *
767
 * @ingroup sanitization
768 769
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
770
  return Xss::filter($string, $allowed_tags);
771 772 773
}

/**
774
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
775
 *
776
 * @param string $string
777
 *   The string with the attribute value.
778
 *
779
 * @return string
780
 *   Cleaned up and HTML-escaped version of $string.
781 782
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
783
 */
784
function filter_xss_bad_protocol($string) {
785
  return Url::filterBadProtocol($string);
786 787 788 789 790 791
}

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

Dries's avatar
 
Dries committed
792
/**
Dries's avatar
 
Dries committed
793
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
794
 * @{
Dries's avatar
 
Dries committed
795
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
796 797
 */

Dries's avatar
 
Dries committed
798 799 800 801 802
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
803
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
804
  $langcode = $langcode ? $langcode : language(Language::TYPE_CONTENT)->id;
Dries's avatar
 
Dries committed
805

Dries's avatar
Dries committed
806
  $output = "<channel>\n";
807
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
808
  $output .= ' <link>' . check_url($link) . "</link>\n";
809 810 811 812

  // 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;).
813 814
  $output .= ' <description>' . String::checkPlain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . String::checkPlain($langcode) . "</language>\n";
815
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
816 817 818 819 820 821
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
822
/**
823
 * Formats a single RSS item.
Dries's avatar
 
Dries committed
824 825 826
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
827
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
828
  $output = "<item>\n";
829
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
830
  $output .= ' <link>' . check_url($link) . "</link>\n";
831
  $output .= ' <description>' . String::checkPlain($description) . "</description>\n";
832 833 834 835 836 837 838
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
839
 * Formats XML elements.
840 841
 *
 * @param $array
842
 *   An array where each item represents an element and is either a:
843 844 845 846 847 848 849 850 851 852
 *   - (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) {
853
  $output = '';
854 855
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
856
      if ($value['key']) {
857
        $output .= ' <' . $value['key'];
858
        if (isset($value['attributes']) && is_array($value['attributes'])) {
859
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
860 861
        }

862
        if (isset($value['value']) && $value['value'] != '') {
863
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
864 865 866 867 868 869 870
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
871
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
872
    }
Dries's avatar
 
Dries committed
873
  }
Dries's avatar
 
Dries committed
874 875 876
  return $output;
}

Dries's avatar
 
Dries committed
877
/**
878
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
879
 *
Dries's avatar
 
Dries committed
880
 * This function ensures that the string is pluralized correctly. Since t() is
881 882
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
883
 *
884 885 886 887 888 889 890 891 892 893
 * 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.',
894
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
895 896
 * @endcode
 *
Dries's avatar
 
Dries committed
897 898 899
 * @param $count
 *   The item count to display.
 * @param $singular
900 901 902
 *   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
903
 * @param $plural
904 905 906
 *   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".
907
 * @param $args
908
 *   An associative array of replacements to make after translation. Instances
909
 *   of any key in this array are replaced with the corresponding value.
910 911 912
 *   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.
913
 * @param $options
914 915
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
916 917
 * @return
 *   A translated string.
918 919 920
 *
 * @see t()
 * @see format_string()
Dries's avatar
 
Dries committed
921
 */
922
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
923
  $args['@count'] = $count;
924 925 926 927 928 929 930
  // Join both forms to search a translation.
  $tranlatable_string = implode(LOCALE_PLURAL_DELIMITER, array($singular, $plural));
  // Translate as usual.
  $translated_strings = t($tranlatable_string, $args, $options);
  // Split joined translation strings into array.
  $translated_array = explode(LOCALE_PLURAL_DELIMITER, $translated_strings);

931
  if ($count == 1) {
932
    return $translated_array[0];
933
  }
Dries's avatar
 
Dries committed
934

935
  // Get the plural index through the gettext formula.
936
  // @todo implement static variable to minimize function_exists() usage.
937
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
938 939 940
  if ($index == 0) {
    // Singular form.
    return $translated_array[0];
Dries's avatar
 
Dries committed
941 942
  }
  else {
943 944 945 946 947 948 949 950 951
    if (isset($translated_array[$index])) {
      // N-th plural form.
      return $translated_array[$index];
    }
    else {
      // If the index cannot be computed or there's no translation, use
      // the second plural form as a fallback (which allows for most flexiblity
      // with the replaceable @count value).
      return $translated_array[1];
Dries's avatar
 
Dries committed
952 953
    }
  }
Dries's avatar
 
Dries committed
954 955
}

956
/**
957
 * Parses a given byte count.
958 959
 *
 * @param $size
960 961
 *   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).
962
 *
963
 * @return
964
 *   An integer representation of the size in bytes.
965 966
 */
function parse_size($size) {
967 968 969 970 971 972 973 974
  $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);
975 976 977
  }
}

Dries's avatar
 
Dries committed
978
/**
979
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
980
 *
Dries's avatar
 
Dries committed
981
 * @param $size
982
 *   A size in bytes.
983
 * @param $langcode
984 985
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
986
 *
Dries's avatar
 
Dries committed
987 988
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
989
 */
990
function format_size($size, $langcode = NULL) {
991
  if ($size < DRUPAL_KILOBYTE) {
992
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
993
  }
994
  else {
995
    $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
996
    $units = array(
997 998 999 1000 1001 1002 1003 1004
      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)),
1005 1006
    );
    foreach ($units as $unit) {
1007 1008
      if (round($size, 2) >= DRUPAL_KILOBYTE) {
        $size = $size / DRUPAL_KILOBYTE;
1009 1010 1011 1012
      }
      else {
        break;
      }
1013
    }
1014
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
1015 1016 1017
  }
}

Dries's avatar
 
Dries committed
1018
/**
1019
 * Formats a time interval with the requested granularity.
Dries's avatar
 
Dries committed
1020
 *
1021
 * @param $interval
Dries's avatar
 
Dries committed
1022 1023 1024
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
1025 1026 1027
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
1028
 *
Dries's avatar
 
Dries committed
1029 1030
 * @return
 *   A translated string representation of the interval.
Dries's avatar
 
Dries committed
1031
 */
1032
function format_interval($interval, $granularity = 2, $langcode = NULL) {