common.inc 192 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\MapArray;
20
use Drupal\Component\Utility\NestedArray;
21
use Drupal\Core\Datetime\DrupalDateTime;
22
use Drupal\Core\Routing\GeneratorNotInitializedException;
23
use Drupal\Core\SystemListingInfo;
24
use Drupal\Core\Template\Attribute;
25
use Drupal\Core\Render\Element;
26

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

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

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

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

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

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

/**
87
 * The default aggregation group for theme CSS files added to the page.
88
 */
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
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;
115

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

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

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

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

136
/**
137 138 139
 * @defgroup block_caching Block Caching
 * @{
 * Constants that define each block's caching state.
140
 *
141 142 143 144 145 146 147 148 149 150
 * 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.
151
 *
152 153
 * The block cache is cleared when the 'content' cache tag is invalidated,
 * following the same pattern as the page cache (node, comment, user, taxonomy
154
 * added or updated...).
155 156 157 158 159
 *
 * Note that user 1 is excluded from block caching.
 */

/**
160 161 162 163 164 165 166
 * 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.
167
 */
168
const DRUPAL_NO_CACHE = -1;
169 170

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

/**
179 180 181 182
 * 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.
183
 */
184
const DRUPAL_CACHE_PER_ROLE = 0x0001;
185 186

/**
187 188
 * The block or element can change depending on the user.
 *
189 190 191
 * 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.
 */
192
const DRUPAL_CACHE_PER_USER = 0x0002;
193 194 195 196

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

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

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

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

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

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

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

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

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

  return $profile;
}

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

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

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
411
/**
412
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
413
 * @{
Dries's avatar
 
Dries committed
414
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
415 416
 */

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

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

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
577
/**
578
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
579
 */
Dries's avatar
 
Dries committed
580

Kjartan's avatar
Kjartan committed
581
/**
Dries's avatar
 
Dries committed
582
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
583
 * @{
Dries's avatar
 
Dries committed
584
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
585 586
 */

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

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

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

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

Dries's avatar
Dries committed
639
/**
640 641 642 643 644 645
 * 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
646 647
 * be a plain-text string for passing to t(), l(),
 * Drupal\Core\Template\Attribute, or another function that will call
648
 * \Drupal\Component\Utility\String::checkPlain() separately.
649 650 651 652 653 654 655
 *
 * @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
656 657
 *   \Drupal\Component\Utility\String::checkPlain() being called on it. However,
 *   it can be passed to functions expecting plain-text strings.
658
 *
659
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
660 661
 */
function drupal_strip_dangerous_protocols($uri) {
662
  return Url::stripDangerousProtocols($uri);
663 664 665
}

/**
666
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
667 668 669 670 671 672 673
 *
 * @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
674 675 676
 *   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
677 678
 *   Drupal\Core\Template\Attribute, call
 *   \Drupal\Component\Utility\Url::stripDangerousProtocols() instead.
679
 *
680 681
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
682 683
 */
function check_url($uri) {
684
  return String::checkPlain(Url::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
685 686
}

687
/**
688
 * Applies a very permissive XSS/HTML filter for admin-only use.
689 690 691
 *
 * Use only for fields where it is impractical to use the
 * whole filter system, but where some (mainly inline) mark-up
692 693
 * is desired (so \Drupal\Component\Utility\String::checkPlain() is not
 * acceptable).
694 695 696
 *
 * Allows all tags that can be used inside an HTML body, save
 * for scripts and styles.
697 698 699 700 701 702 703 704
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
705 706
 */
function filter_xss_admin($string) {
707
  return Xss::filterAdmin($string);
708 709 710
}

/**
711
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
712
 *
713 714
 * 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.
715 716
 *
 * This code does four things:
717 718 719 720 721
 * - 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:).
722 723
 *
 * @param $string
724 725
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
726 727
 * @param $allowed_tags
 *   An array of allowed tags.
728 729 730 731 732
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
733 734
 * @see \Drupal\Component\Utility\Xss::filter()
 *
735
 * @ingroup sanitization
736 737
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
738
  return Xss::filter($string, $allowed_tags);
739 740 741
}

/**
742
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
743
 *
744
 * @param string $string
745
 *   The string with the attribute value.
746
 *
747
 * @return string
748
 *   Cleaned up and HTML-escaped version of $string.
749 750
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
751
 */
752
function filter_xss_bad_protocol($string) {
753
  return Url::filterBadProtocol($string);
754 755 756 757 758 759
}

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

Dries's avatar
 
Dries committed
760
/**
Dries's avatar
 
Dries committed
761
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
762
 * @{
Dries's avatar
 
Dries committed
763
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
764 765
 */

Dries's avatar
 
Dries committed
766 767 768 769 770
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
771
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
772
  $langcode = $langcode ? $langcode : \Drupal::languageManager()->getCurrentLanguage(Language::TYPE_CONTENT)->id;
Dries's avatar
 
Dries committed
773

Dries's avatar
Dries committed
774
  $output = "<channel>\n";
775
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
776
  $output .= ' <link>' . check_url($link) . "</link>\n";
777 778 779 780

  // 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;).
781 782
  $output .= ' <description>' . String::checkPlain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . String::checkPlain($langcode) . "</language>\n";
783
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
784 785 786 787 788 789
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
790
/**
791
 * Formats a single RSS item.
Dries's avatar
 
Dries committed
792 793 794
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
795
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
796
  $output = "<item>\n";
797
  $output .= ' <title>' . String::checkPlain($title) . "</title>\n";
798
  $output .= ' <link>' . check_url($link) . "</link>\n";
799
  $output .= ' <description>' . String::checkPlain($description) . "</description>\n";
800 801 802 803 804 805 806
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
807
 * Formats XML elements.
808 809
 *
 * @param $array
810
 *   An array where each item represents an element and is either a:
811 812 813 814 815 816 817 818 819 820
 *   - (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) {
821
  $output = '';
822 823
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
824
      if ($value['key']) {
825
        $output .= ' <' . $value['key'];
826
        if (isset($value['attributes']) && is_array($value['attributes'])) {
827
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
828 829
        }

830
        if (isset($value['value']) && $value['value'] != '') {
831
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
832 833 834 835 836 837 838
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
839
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
840
    }
Dries's avatar
 
Dries committed
841
  }
Dries's avatar
 
Dries committed
842 843 844
  return $output;
}

Dries's avatar
 
Dries committed
845
/**
846
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
847
 *
Dries's avatar
 
Dries committed
848
 * This function ensures that the string is pluralized correctly. Since t() is
849 850
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
851
 *
852 853 854 855 856 857 858 859 860 861
 * 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.',
862
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
863 864
 * @endcode
 *
Dries's avatar
 
Dries committed
865 866 867
 * @param $count
 *   The item count to display.
 * @param $singular
868 869 870
 *   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
871
 * @param $plural
872 873 874
 *   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".
875
 * @param $args
876
 *   An associative array of replacements to make after translation. Instances
877
 *   of any key in this array are replaced with the corresponding value.
878 879 880
 *   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.
881
 * @param $options
882 883
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
884 885
 * @return
 *   A translated string.
886 887 888
 *
 * @see t()
 * @see format_string()
889
 * @see \Drupal\Core\StringTranslation\TranslationManager->formatPlural()
890
 *
891 892
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::translation()->formatPlural().
Dries's avatar
 
Dries committed
893
 */
894
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
895
  return \Drupal::translation()->formatPlural($count, $singular, $plural, $args, $options);
Dries's avatar
 
Dries committed
896 897
}

898
/**
899
 * Parses a given byte count.
900 901
 *
 * @param $size
902 903
 *   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).
904
 *
905
 * @return
906
 *   An integer representation of the size in bytes.
907 908
 */
function parse_size($size) {
909 910 911 912 913 914 915 916
  $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);
917 918 919
  }
}

Dries's avatar
 
Dries committed
920
/**
921
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
922
 *
Dries's avatar
 
Dries committed
923
 * @param $size
924
 *   A size in bytes.
925
 * @param $langcode
926 927
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
928
 *
Dries's avatar
 
Dries committed
929 930
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
931
 */
932
function format_size($size, $langcode = NULL) {
933
  if ($size < DRUPAL_KILOBYTE) {
934
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
935
  }
936
  else {
937
    $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
938
    $units = array(
939 940 941 942 943 944 945 946
      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)),
947 948
    );
    foreach ($units as $unit) {
949 950
      if (round($size, 2) >= DRUPAL_KILOBYTE) {
        $size = $size / DRUPAL_KILOBYTE;
951 952 953 954
      }
      else {
        break;
      }
955
    }
956
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
957 958 959
  }
}

Dries's avatar
 
Dries committed
960
/**
961
 * Formats a time interval with the requested granularity.
Dries's avatar
 
Dries committed
962
 *
963
 * @param $interval
Dries's avatar
 
Dries committed
964 965 966
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
967 968 969
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
970
 *
Dries's avatar
 
Dries committed
971 972
 * @return
 *   A translated string representation of the interval.
973
 *
974 975 976 977
 * @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
978
 */
979
function format_interval($interval, $granularity = 2, $langcode = NULL) {
980
  return \Drupal::service('date')->formatInterval($interval, $granularity, $langcode);
Dries's avatar
 
Dries committed
981 982
}

Dries's avatar
 
Dries committed
983
/**
984
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
985
 *
Dries's avatar
 
Dries committed
986
 * @param $timestamp
987
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
988
 * @param $type
989
 *   (optional) The format to use, one of:
990 991 992 993 994
 *   - 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.
995 996 997
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
998
 * @param $format
999 1000 1001
 *   (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
1002
 * @param $timezone
1003
 *   (optional) Time zone identifier, as described at
1004
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
1005
 *   display the page.
1006
 * @param $langcode
1007 1008 1009
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
1010 1011
 * @return
 *   A translated date string in the requested format.
1012 1013
 *
 * @see \Drupal\Component\Datetime\Date::format()
Dries's avatar
 
Dries committed
1014
 */
1015
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {