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

3
use Drupal\Component\Utility\Crypt;
4
use Drupal\Component\Utility\String;
5
use Drupal\Component\Utility\Tags;
6 7
use Drupal\Component\Utility\UrlValidator;
use Drupal\Component\Utility\Xss;
8
use Drupal\Core\Cache\Cache;
9
use Drupal\Core\Language\Language;
10
use Symfony\Component\DependencyInjection\Container;
11
use Symfony\Component\HttpFoundation\RedirectResponse;
12
use Symfony\Component\Yaml\Parser;
13 14
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
15
use Drupal\Component\PhpStorage\PhpStorageFactory;
16
use Drupal\Component\Utility\MapArray;
17
use Drupal\Component\Utility\NestedArray;
18
use Drupal\Component\Utility\Unicode;
19
use Drupal\Core\Cache\CacheBackendInterface;
20
use Drupal\Core\Datetime\DrupalDateTime;
21
use Drupal\Core\Database\Database;
22
use Drupal\Core\Routing\GeneratorNotInitializedException;
23
use Drupal\Core\SystemListingInfo;
24
use Drupal\Core\Template\Attribute;
25 26
use Zend\Feed\Writer\Writer;
use Zend\Feed\Reader\Reader;
27

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

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

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

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

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

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

/**
88
 * The default aggregation group for theme CSS files added to the page.
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 115
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;
116

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

261
/**
262
 * Gets the name of the currently active installation profile.
263 264 265 266
 *
 * 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
 * installation state. At all other times, the standard Drupal systems variable
267 268
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
269 270
 *
 * @return $profile
271
 *   The name of the installation profile.
272 273 274 275 276 277 278 279
 */
function drupal_get_profile() {
  global $install_state;

  if (isset($install_state['parameters']['profile'])) {
    $profile = $install_state['parameters']['profile'];
  }
  else {
280
    $profile = variable_get('install_profile', 'standard');
281 282 283 284 285 286
  }

  return $profile;
}


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

302
  if (isset($breadcrumb)) {
Dries's avatar
Dries committed
303 304 305 306 307
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

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

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

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

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

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

397
  if (isset($url)) {
398
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
399

400 401 402 403 404 405 406 407
    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)),
    ));
408 409 410 411 412
  }
  return $stored_feed_links;
}

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

Dries's avatar
Dries committed
423
/**
424
 * @defgroup http_handling HTTP handling
Dries's avatar
Dries committed
425
 * @{
Dries's avatar
Dries committed
426
 * Functions to properly handle HTTP responses.
Dries's avatar
Dries committed
427 428
 */

429
/**
430
 * Processes a URL query parameter array to remove unwanted elements.
431 432
 *
 * @param $query
433
 *   (optional) An array to be processed. Defaults to $_GET.
434
 * @param $exclude
435
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
436
 *   exclude nested items.
437
 * @param $parent
438 439
 *   Internal use only. Used to build the $query array key for nested items.
 *
440
 * @return
441
 *   An array containing query parameters, which can be used for url().
442
 */
443
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
444 445 446 447 448 449 450 451 452 453 454
  // Set defaults, if none given.
  if (!isset($query)) {
    $query = $_GET;
  }
  // If $exclude is empty, there is nothing to filter.
  if (empty($exclude)) {
    return $query;
  }
  elseif (!$parent) {
    $exclude = array_flip($exclude);
  }
455

456
  $params = array();
457
  foreach ($query as $key => $value) {
458 459 460
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
461 462
    }

463 464 465 466 467
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
468
    }
469 470 471 472 473
  }

  return $params;
}

474
/**
475
 * Splits a URL-encoded query string into an array.
476 477 478 479 480
 *
 * @param $query
 *   The query string to split.
 *
 * @return
481
 *   An array of URL decoded couples $param_name => $value.
482 483 484 485 486 487
 */
function drupal_get_query_array($query) {
  $result = array();
  if (!empty($query)) {
    foreach (explode('&', $query) as $param) {
      $param = explode('=', $param);
488
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
489 490 491 492 493
    }
  }
  return $result;
}

494
/**
495
 * Parses an array into a valid, rawurlencoded query string.
496
 *
497
 * @see \Drupal\Core\Routing\PathBasedGeneratorInterface::httpBuildQuery()
498
 * @see drupal_get_query_parameters()
499 500
 * @deprecated as of Drupal 8.0. Use
 *   Drupal::urlGenerator()->httpBuildQuery() instead.
501 502 503
 * @ingroup php_wrappers
 */
function drupal_http_build_query(array $query, $parent = '') {
504
  return Drupal::urlGenerator()->httpBuildQuery($query, $parent);
505 506
}

507
/**
508
 * Prepares a 'destination' URL query parameter for use with url().
509
 *
510 511 512 513
 * 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.
514
 *
515 516 517 518 519 520
 * @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()
521 522
 */
function drupal_get_destination() {
523 524 525 526 527 528
  $destination = &drupal_static(__FUNCTION__);

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

529
  if (isset($_GET['destination'])) {
530
    $destination = array('destination' => $_GET['destination']);
531 532
  }
  else {
533
    $path = current_path();
534
    $query = Drupal::urlGenerator()->httpBuildQuery(drupal_get_query_parameters());
535
    if ($query != '') {
536
      $path .= '?' . $query;
537
    }
538 539 540 541 542 543
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
544
 * Parses a system URL string into an associative array suitable for url().
545 546
 *
 * This function should only be used for URLs that have been generated by the
547 548
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
 *
 * 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
 */
function drupal_parse_url($url) {
  $options = array(
    'path' => NULL,
    'query' => array(),
    'fragment' => '',
  );

  // External URLs: not using parse_url() here, so we do not have to rebuild
  // the scheme, host, and path without having any use for it.
  if (strpos($url, '://') !== FALSE) {
    // Split off everything before the query string into 'path'.
    $parts = explode('?', $url);
    $options['path'] = $parts[0];
    // If there is a query string, transform it into keyed query parameters.
    if (isset($parts[1])) {
      $query_parts = explode('#', $parts[1]);
      parse_str($query_parts[0], $options['query']);
      // Take over the fragment, if there is any.
      if (isset($query_parts[1])) {
        $options['fragment'] = $query_parts[1];
      }
    }
  }
  // Internal URLs.
  else {
601 602 603 604 605
    // parse_url() does not support relative URLs, so make it absolute. E.g. the
    // relative URL "foo/bar:1" isn't properly parsed.
    $parts = parse_url('http://example.com/' . $url);
    // Strip the leading slash that was just added.
    $options['path'] = substr($parts['path'], 1);
606 607 608 609 610 611 612 613 614 615 616 617
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

/**
618
 * Encodes a Drupal path for use in a URL.
619
 *
620
 * For aesthetic reasons slashes are not escaped.
621
 *
622 623
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
624 625
 *
 * @param $path
626
 *   The Drupal path to encode.
627 628
 */
function drupal_encode_path($path) {
629
  return str_replace('%2F', '/', rawurlencode($path));
630 631
}

632 633 634 635 636 637 638 639 640 641
/**
 * 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.
 */
function _external_url_is_local($url) {
642 643
  $url_parts = parse_url($url);
  $base_host = parse_url($GLOBALS['base_url'], PHP_URL_HOST);
644

645 646 647 648
  if (!isset($url_parts['path'])) {
    return ($url_parts['host'] == $base_host);
  }
  else {
649 650 651 652
    // When comparing base paths, we need a trailing slash to make sure a
    // partial URL match isn't occuring. Since base_path() always returns with
    // a trailing slash, we don't need to add the trailing slash here.
    return ($url_parts['host'] == $base_host && stripos($url_parts['path'], base_path()) === 0);
653
  }
654 655
}

656 657 658 659 660 661 662
/**
 * 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) {
663
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
664 665 666
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
Dries committed
667
/**
668
 * @} End of "defgroup http_handling".
Dries's avatar
Dries committed
669
 */
Dries's avatar
Dries committed
670

671
/**
Dries's avatar
Dries committed
672
 * @defgroup validation Input validation
Dries's avatar
Dries committed
673
 * @{
Dries's avatar
Dries committed
674
 * Functions to validate user input.
675 676
 */

677
/**
678
 * Verifies the syntax of the given e-mail address.
Dries's avatar
Dries committed
679
 *
680 681
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
682
 *
Dries's avatar
Dries committed
683
 * @param $mail
684
 *   A string containing an e-mail address.
685
 *
Dries's avatar
Dries committed
686
 * @return
Dries's avatar
Dries committed
687
 *   TRUE if the address is in a valid format.
688
 */
Dries's avatar
Dries committed
689
function valid_email_address($mail) {
690
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
691 692
}

Dries's avatar
Dries committed
693
/**
694
 * Verifies the syntax of the given URL.
Dries's avatar
Dries committed
695
 *
696 697
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
698
 * Valid values per RFC 3986.
Dries's avatar
Dries committed
699
 * @param $url
Dries's avatar
Dries committed
700
 *   The URL to verify.
Dries's avatar
Dries committed
701
 * @param $absolute
Dries's avatar
Dries committed
702
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
703
 *
Dries's avatar
Dries committed
704
 * @return
Dries's avatar
Dries committed
705
 *   TRUE if the URL is in a valid format.
706 707
 *
 * @see \Drupal\Component\Utility\UrlValidator::isValid()
708 709
 *
 * @deprecated as of Drupal 8.0. Use UrlValidator::isValid() instead.
Dries's avatar
Dries committed
710
 */
Dries's avatar
Dries committed
711
function valid_url($url, $absolute = FALSE) {
712
  return UrlValidator::isValid($url, $absolute);
Dries's avatar
Dries committed
713 714
}

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
/**
 * Verifies that a number is a multiple of a given step.
 *
 * The implementation assumes it is dealing with IEEE 754 double precision
 * floating point numbers that are used by PHP on most systems.
 *
 * This is based on the number/range verification methods of webkit.
 *
 * @param $value
 *   The value that needs to be checked.
 * @param $step
 *   The step scale factor. Must be positive.
 * @param $offset
 *   (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.
 *
 * @see http://opensource.apple.com/source/WebCore/WebCore-1298/html/NumberInputType.cpp
 */
function valid_number_step($value, $step, $offset = 0.0) {
  $double_value = (double) abs($value - $offset);

  // The fractional part of a double has 53 bits. The greatest number that could
  // be represented with that is 2^53. If the given value is even bigger than
  // $step * 2^53, then dividing by $step will result in a very small remainder.
  // Since that remainder can't even be represented with a single precision
  // float the following computation of the remainder makes no sense and we can
  // safely ignore it instead.
  if ($double_value / pow(2.0, 53) > $step) {
    return TRUE;
  }

  // Now compute that remainder of a division by $step.
  $remainder = (double) abs($double_value - $step * round($double_value / $step));

  // $remainder is a double precision floating point number. Remainders that
  // can't be represented with single precision floats are acceptable. The
  // fractional part of a float has 24 bits. That means remainders smaller than
  // $step * 2^-24 are acceptable.
  $computed_acceptable_error = (double)($step / pow(2.0, 24));

  return $computed_acceptable_error >= $remainder || $remainder >= ($step - $computed_acceptable_error);
}

761 762 763 764
/**
 * @} End of "defgroup validation".
 */

765 766 767 768
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
769 770 771
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
772 773
 */

Dries's avatar
Dries committed
774
/**
775 776 777 778 779 780
 * 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
781 782 783
 * be a plain-text string for passing to t(), l(),
 * Drupal\Core\Template\Attribute, or another function that will call
 * check_plain() separately.
784 785 786 787 788 789 790 791 792 793
 *
 * @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
 *   check_plain() being called on it. However, it can be passed to functions
 *   expecting plain-text strings.
 *
794
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
795 796
 */
function drupal_strip_dangerous_protocols($uri) {
797
  return UrlValidator::stripDangerousProtocols($uri);
798 799 800
}

/**
801
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
802 803 804 805 806 807 808
 *
 * @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
809 810 811 812 813
 *   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
 *   Drupal\Core\Template\Attribute, call drupal_strip_dangerous_protocols()
 *   instead.
814
 *
815 816
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
817 818
 */
function check_url($uri) {
819
  return String::checkPlain(UrlValidator::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
820 821
}

822
/**
823
 * Applies a very permissive XSS/HTML filter for admin-only use.
824 825 826 827 828 829 830
 *
 * Use only for fields where it is impractical to use the
 * whole filter system, but where some (mainly inline) mark-up
 * is desired (so check_plain() is not acceptable).
 *
 * Allows all tags that can be used inside an HTML body, save
 * for scripts and styles.
831 832 833 834 835 836 837 838
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
839 840
 */
function filter_xss_admin($string) {
841
  return Xss::filterAdmin($string);
842 843 844
}

/**
845
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
846
 *
847 848
 * 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.
849 850
 *
 * This code does four things:
851 852 853 854 855
 * - 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:).
856 857
 *
 * @param $string
858 859
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
860 861
 * @param $allowed_tags
 *   An array of allowed tags.
862 863 864 865 866
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
867 868
 * @see \Drupal\Component\Utility\Xss::filter()
 *
869
 * @ingroup sanitization
870 871
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
872
  return Xss::filter($string, $allowed_tags);
873 874 875
}

/**
876
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
877
 *
878
 * @param string $string
879
 *   The string with the attribute value.
880
 *
881
 * @return string
882
 *   Cleaned up and HTML-escaped version of $string.
883 884
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
885
 */
886 887
function filter_xss_bad_protocol($string) {
  return UrlValidator::filterBadProtocol($string);
888 889 890 891 892 893
}

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

Dries's avatar
Dries committed
894
/**
Dries's avatar
Dries committed
895
 * @defgroup format Formatting
Dries's avatar
Dries committed
896
 * @{
Dries's avatar
Dries committed
897
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
Dries committed
898 899
 */

Dries's avatar
Dries committed
900 901 902 903 904
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
905
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
906
  $langcode = $langcode ? $langcode : language(Language::TYPE_CONTENT)->langcode;
Dries's avatar
Dries committed
907

Dries's avatar
Dries committed
908
  $output = "<channel>\n";
909 910
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
911 912 913 914

  // 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;).
915 916
  $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . check_plain($langcode) . "</language>\n";
917
  $output .= format_xml_elements($args);
Dries's avatar
Dries committed
918 919 920 921 922 923
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
Dries committed
924
/**
925
 * Formats a single RSS item.
Dries's avatar
Dries committed
926 927 928
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
Dries committed
929
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
930
  $output = "<item>\n";
931 932 933
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
  $output .= ' <description>' . check_plain($description) . "</description>\n";
934 935 936 937 938 939 940
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
941
 * Formats XML elements.
942 943
 *
 * @param $array
944
 *   An array where each item represents an element and is either a:
945 946 947 948 949 950 951 952 953 954
 *   - (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) {
955
  $output = '';
956 957
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
Dries committed
958
      if ($value['key']) {
959
        $output .= ' <' . $value['key'];
960
        if (isset($value['attributes']) && is_array($value['attributes'])) {
961
          $output .= new Attribute($value['attributes']);
Dries's avatar
Dries committed
962 963
        }

964
        if (isset($value['value']) && $value['value'] != '') {
965
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
Dries committed
966 967 968 969 970 971 972
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
973
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
Dries's avatar
Dries committed
974
    }
Dries's avatar
Dries committed
975
  }
Dries's avatar
Dries committed
976 977 978
  return $output;
}

Dries's avatar
Dries committed
979
/**
980
 * Formats a string containing a count of items.
Dries's avatar
Dries committed
981
 *
Dries's avatar
Dries committed
982
 * This function ensures that the string is pluralized correctly. Since t() is
983 984
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
Dries committed
985
 *
986 987 988 989 990 991 992 993 994 995
 * 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.',
996
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
997 998
 * @endcode
 *
Dries's avatar
Dries committed
999 1000 1001
 * @param $count
 *   The item count to display.
 * @param $singular
1002 1003 1004
 *   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
1005
 * @param $plural
1006 1007 1008
 *   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".
1009
 * @param $args
1010
 *   An associative array of replacements to make after translation. Instances
1011
 *   of any key in this array are replaced with the corresponding value.
1012 1013 1014
 *   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.
1015
 * @param $options
1016 1017
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
Dries committed
1018 1019
 * @return
 *   A translated string.
1020 1021 1022
 *
 * @see t()
 * @see format_string()
Dries's avatar
Dries committed
1023
 */
1024
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
1025
  $args['@count'] = $count;
1026 1027 1028 1029 1030 1031 1032
  // 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);

1033
  if ($count == 1) {
1034
    return $translated_array[0];
1035
  }
Dries's avatar
Dries committed
1036

1037
  // Get the plural index through the gettext formula.
1038
  // @todo implement static variable to minimize function_exists() usage.
1039
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
1040 1041 1042
  if ($index == 0) {
    // Singular form.
    return $translated_array[0];
Dries's avatar
Dries committed
1043 1044
  }
  else {
1045 1046 1047 1048 1049 1050 1051 1052 1053
    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
1054 1055
    }
  }
Dries's avatar
Dries committed
1056 1057
}

1058
/**
1059
 * Parses a given byte count.
1060 1061
 *
 * @param $size
1062 1063
 *   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).
1064
 *
1065
 * @return
1066
 *   An integer representation of the size in bytes.
1067 1068
 */
function parse_size($size) {
1069 1070 1071 1072 1073 1074 1075 1076
  $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);
1077 1078 1079
  }
}

Dries's avatar
Dries committed
1080
/**
1081
 * Generates a string representation for the given byte count.
Dries's avatar
Dries committed
1082
 *
Dries's avatar
Dries committed
1083
 * @param $size
1084
 *   A size in bytes.
1085
 * @param $langcode
1086 1087
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
1088
 *
Dries's avatar
Dries committed
1089 1090
 * @return
 *   A translated string representation of the size.
Dries's avatar
Dries committed
1091
 */
1092
function format_size($size, $langcode = NULL) {
1093
  if ($size < DRUPAL_KILOBYTE) {
1094
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
Dries committed
1095
  }
1096
  else {
1097
    $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
1098
    $units = array(
1099 1100 1101 1102 1103 1104 1105 1106
      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)),
1107 1108
    );
    foreach ($units as $unit) {
1109 1110
      if (round($size, 2) >= DRUPAL_KILOBYTE) {
        $size = $size / DRUPAL_KILOBYTE;
1111 1112 1113 1114
      }
      else {
        break;
      }
1115
    }
1116
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
Dries committed
1117 1118 1119
  }
}

Dries's avatar
Dries committed
1120
/**
1121
 * Formats a time interval with the requested granularity.
Dries's avatar
Dries committed
1122
 *
1123
 * @param $interval
Dries's avatar
Dries committed
1124 1125 1126
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
1127 1128 1129
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
1130
 *
Dries's avatar
Dries committed
1131 1132
 * @return
 *   A translated string representation of the interval.
Dries's avatar
Dries committed
1133
 */
1134
function format_interval($interval, $granularity = 2, $langcode = NULL) {
1135 1136 1137 1138 1139 1140 1141 1142 1143
  $units = array(
    '1 year|@count years' => 31536000,
    '1 month|@count months' => 2592000,
    '1 week|@count weeks' => 604800,
    '1 day|@count days' => 86400,
    '1 hour|@count hours' => 3600,
    '1 min|@count min' => 60,
    '1 sec|@count sec' => 1
  );
Dries's avatar
Dries committed
1144
  $output = '';