common.inc 176 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\String;
6
use Drupal\Component\Utility\Tags;
7
use Drupal\Component\Utility\Url;
8
use Drupal\Component\Utility\Xss;
9
use Drupal\Core\Cache\Cache;
10
use Drupal\Core\Language\Language;
11
use Symfony\Component\DependencyInjection\Container;
12
use Symfony\Component\HttpFoundation\RedirectResponse;
13
use Symfony\Component\Yaml\Parser;
14 15
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
16
use Drupal\Component\PhpStorage\PhpStorageFactory;
17
use Drupal\Component\Utility\MapArray;
18
use Drupal\Component\Utility\NestedArray;
19
use Drupal\Component\Utility\Unicode;
20
use Drupal\Core\Cache\CacheBackendInterface;
21
use Drupal\Core\Datetime\DrupalDateTime;
22
use Drupal\Core\Database\Database;
23
use Drupal\Core\Routing\GeneratorNotInitializedException;
24
use Drupal\Core\SystemListingInfo;
25
use Drupal\Core\Template\Attribute;
26 27
use Zend\Feed\Writer\Writer;
use Zend\Feed\Reader\Reader;
28

29 30 31 32 33 34 35 36 37
use Drupal\Core\Asset\CssCollectionRenderer;
use Drupal\Core\Asset\CssCollectionOptimizer;
use Drupal\Core\Asset\CssCollectionGrouper;
use Drupal\Core\Asset\CssOptimizer;
use Drupal\Core\Asset\JsCollectionRenderer;
use Drupal\Core\Asset\JsCollectionOptimizer;
use Drupal\Core\Asset\JsCollectionGrouper;
use Drupal\Core\Asset\AssetDumper;

Dries's avatar
 
Dries committed
38 39 40 41 42 43 44 45
/**
 * @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.
 */

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
/**
 * @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
 *
74
 * @}
75 76
 */

77 78 79
/**
 * Return status for saving which involved creating a new item.
 */
80
const SAVED_NEW = 1;
81 82 83 84

/**
 * Return status for saving which involved an update to an existing item.
 */
85
const SAVED_UPDATED = 2;
86 87 88 89

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

92
/**
93
 * The default aggregation group for CSS files added to the page.
94
 */
95
const CSS_AGGREGATE_DEFAULT = 0;
96 97

/**
98
 * The default aggregation group for theme CSS files added to the page.
99
 */
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
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;
126

127 128 129 130 131
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

132
/**
133
 * The default group for JavaScript and jQuery libraries added to the page.
134
 */
135
const JS_LIBRARY = -100;
136 137

/**
138
 * The default group for module JavaScript code added to the page.
139
 */
140
const JS_DEFAULT = 0;
141 142

/**
143
 * The default group for theme JavaScript code added to the page.
144
 */
145
const JS_THEME = 100;
146

147
/**
148 149 150
 * @defgroup block_caching Block Caching
 * @{
 * Constants that define each block's caching state.
151
 *
152 153 154 155 156 157 158 159 160 161
 * 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.
162
 *
163 164
 * The block cache is cleared when the 'content' cache tag is invalidated,
 * following the same pattern as the page cache (node, comment, user, taxonomy
165
 * added or updated...).
166 167 168 169 170
 *
 * Note that user 1 is excluded from block caching.
 */

/**
171 172 173 174 175 176 177
 * 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.
178
 */
179
const DRUPAL_NO_CACHE = -1;
180 181

/**
182 183
 * The block is handling its own caching in its hook_block_view().
 *
184 185
 * This setting is useful when time based expiration is needed or a site uses a
 * node access which invalidates standard block cache.
186
 */
187
const DRUPAL_CACHE_CUSTOM = -2;
188 189

/**
190 191 192 193
 * 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.
194
 */
195
const DRUPAL_CACHE_PER_ROLE = 0x0001;
196 197

/**
198 199
 * The block or element can change depending on the user.
 *
200 201 202
 * 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.
 */
203
const DRUPAL_CACHE_PER_USER = 0x0002;
204 205 206 207

/**
 * The block or element can change depending on the page being viewed.
 */
208
const DRUPAL_CACHE_PER_PAGE = 0x0004;
209 210

/**
211
 * The block or element is the same for every user and page that it is visible.
212
 */
213
const DRUPAL_CACHE_GLOBAL = 0x0008;
214

215 216 217 218
/**
 * @} End of "defgroup block_caching".
 */

219 220 221 222 223 224 225 226 227
/**
 * 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";

228
/**
229
 * Adds content to a specified region.
230 231
 *
 * @param $region
232
 *   Page region the content is added to.
233
 * @param $data
234
 *   Content to be added.
235
 */
236
function drupal_add_region_content($region = NULL, $data = NULL) {
237 238
  static $content = array();

239
  if (isset($region) && isset($data)) {
240 241 242 243 244 245
    $content[$region][] = $data;
  }
  return $content;
}

/**
246
 * Gets assigned content for a given region.
247 248
 *
 * @param $region
249 250
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
251
 * @param $delimiter
252
 *   Content to be inserted between imploded array elements.
253
 */
254 255
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
256 257
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
258
      return implode($delimiter, $content[$region]);
259
    }
260 261 262 263
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
264
        $content[$region] = implode($delimiter, $content[$region]);
265 266 267 268 269 270
      }
    }
    return $content;
  }
}

271
/**
272
 * Gets the name of the currently active installation profile.
273 274 275 276
 *
 * 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
277 278
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
279 280
 *
 * @return $profile
281
 *   The name of the installation profile.
282 283 284 285 286 287 288 289
 */
function drupal_get_profile() {
  global $install_state;

  if (isset($install_state['parameters']['profile'])) {
    $profile = $install_state['parameters']['profile'];
  }
  else {
290
    $profile = variable_get('install_profile', 'standard');
291 292 293 294 295 296
  }

  return $profile;
}


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

312
  if (isset($breadcrumb)) {
Dries's avatar
 
Dries committed
313 314 315 316 317
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

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

339 340 341 342 343 344 345 346 347 348
  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
349 350 351 352
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
353
/**
354 355 356 357 358 359 360 361 362 363
 * 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(
364
      'charset' => 'utf-8',
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
    ),
    // 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;
}

/**
386
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
Dries's avatar
 
Dries committed
387
 */
Dries's avatar
Dries committed
388
function drupal_get_html_head() {
389 390 391
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
392 393
}

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

407
  if (isset($url)) {
408
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
409

410 411 412 413 414 415 416 417
    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)),
    ));
418 419 420 421 422
  }
  return $stored_feed_links;
}

/**
423
 * Gets the feed URLs for the current page.
424 425
 *
 * @param $delimiter
426
 *   A delimiter to split feeds by.
427 428 429 430 431 432
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
 
Dries committed
433
/**
434
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
435
 * @{
Dries's avatar
 
Dries committed
436
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
437 438
 */

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

462
/**
463
 * Parses an array into a valid, rawurlencoded query string.
464
 *
465
 * @see \Drupal\Core\Routing\PathBasedGeneratorInterface::httpBuildQuery()
466
 * @see drupal_get_query_parameters()
467
 * @deprecated as of Drupal 8.0. Use Url::buildQuery() instead.
468
 * @ingroup php_wrappers
469 470
 *
 * @deprecated as of Drupal 8.0. Use Url::buildQuery() instead.
471 472
 */
function drupal_http_build_query(array $query, $parent = '') {
473
  return Url::buildQuery($query, $parent);
474 475
}

476
/**
477
 * Prepares a 'destination' URL query parameter for use with url().
478
 *
479 480 481 482
 * 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.
483
 *
484 485 486 487 488 489
 * @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()
490 491
 */
function drupal_get_destination() {
492 493 494 495 496 497
  $destination = &drupal_static(__FUNCTION__);

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

498 499 500
  $query = Drupal::request()->query;
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
501 502
  }
  else {
503
    $path = current_path();
504
    $query = Url::buildQuery(Url::filterQueryParameters($query->all()));
505
    if ($query != '') {
506
      $path .= '?' . $query;
507
    }
508 509 510 511 512 513
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
514
 * Parses a system URL string into an associative array suitable for url().
515 516
 *
 * This function should only be used for URLs that have been generated by the
517 518
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
 *
 * 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
545 546
 *
 * @deprecated as of Drupal 8.0. Use Url::parse() instead.
547 548
 */
function drupal_parse_url($url) {
549
  return Url::parse($url);
550 551 552
}

/**
553
 * Encodes a Drupal path for use in a URL.
554
 *
555
 * For aesthetic reasons slashes are not escaped.
556
 *
557 558
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
559 560
 *
 * @param $path
561
 *   The Drupal path to encode.
562 563
 *
 * @deprecated as of Drupal 8.0. Use Url::encodePath() instead.
564 565
 */
function drupal_encode_path($path) {
566
  return Url::encodePath($path);
567 568
}

569 570 571 572 573 574 575 576
/**
 * 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.
577 578
 *
 * @deprecated as of Drupal 8.0. Use Url::externalIsLocal() instead.
579 580
 */
function _external_url_is_local($url) {
581
  return Url::externalIsLocal($url, base_path());
582 583
}

584 585 586 587 588 589 590
/**
 * 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) {
591
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
592 593 594
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
 
Dries committed
595
/**
596
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
597
 */
Dries's avatar
 
Dries committed
598

Kjartan's avatar
Kjartan committed
599
/**
Dries's avatar
 
Dries committed
600
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
601
 * @{
Dries's avatar
 
Dries committed
602
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
603 604
 */

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

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

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
/**
 * 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);
}

689 690 691 692
/**
 * @} End of "defgroup validation".
 */

693 694 695 696
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
697 698 699
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
700 701
 */

Dries's avatar
Dries committed
702
/**
703 704 705 706 707 708
 * 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
709 710 711
 * be a plain-text string for passing to t(), l(),
 * Drupal\Core\Template\Attribute, or another function that will call
 * check_plain() separately.
712 713 714 715 716 717 718 719 720 721
 *
 * @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.
 *
722
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
723 724
 */
function drupal_strip_dangerous_protocols($uri) {
725
  return Url::stripDangerousProtocols($uri);
726 727 728
}

/**
729
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
730 731 732 733 734 735 736
 *
 * @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
737 738 739 740 741
 *   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.
742
 *
743 744
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
745 746
 */
function check_url($uri) {
747
  return String::checkPlain(Url::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
748 749
}

750
/**
751
 * Applies a very permissive XSS/HTML filter for admin-only use.
752 753 754 755 756 757 758
 *
 * 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.
759 760 761 762 763 764 765 766
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
767 768
 */
function filter_xss_admin($string) {
769
  return Xss::filterAdmin($string);
770 771 772
}

/**
773
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
774
 *
775 776
 * 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.
777 778
 *
 * This code does four things:
779 780 781 782 783
 * - 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:).
784 785
 *
 * @param $string
786 787
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
788 789
 * @param $allowed_tags
 *   An array of allowed tags.
790 791 792 793 794
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
795 796
 * @see \Drupal\Component\Utility\Xss::filter()
 *
797
 * @ingroup sanitization
798 799
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
800
  return Xss::filter($string, $allowed_tags);
801 802 803
}

/**
804
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
805
 *
806
 * @param string $string
807
 *   The string with the attribute value.
808
 *
809
 * @return string
810
 *   Cleaned up and HTML-escaped version of $string.
811 812
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
813
 */
814
function filter_xss_bad_protocol($string) {
815
  return Url::filterBadProtocol($string);
816 817 818 819 820 821
}

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

Dries's avatar
 
Dries committed
822
/**
Dries's avatar
 
Dries committed
823
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
824
 * @{
Dries's avatar
 
Dries committed
825
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
826 827
 */

Dries's avatar
 
Dries committed
828 829 830 831 832
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
833
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
834
  $langcode = $langcode ? $langcode : language(Language::TYPE_CONTENT)->id;
Dries's avatar
 
Dries committed
835

Dries's avatar
Dries committed
836
  $output = "<channel>\n";
837 838
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
839 840 841 842

  // 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;).
843 844
  $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . check_plain($langcode) . "</language>\n";
845
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
846 847 848 849 850 851
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
852
/**
853
 * Formats a single RSS item.
Dries's avatar
 
Dries committed
854 855 856
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
857
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
858
  $output = "<item>\n";
859 860 861
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
  $output .= ' <description>' . check_plain($description) . "</description>\n";
862 863 864 865 866 867 868
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
869
 * Formats XML elements.
870 871
 *
 * @param $array
872
 *   An array where each item represents an element and is either a:
873 874 875 876 877 878 879 880 881 882
 *   - (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) {
883
  $output = '';
884 885
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
886
      if ($value['key']) {
887
        $output .= ' <' . $value['key'];
888
        if (isset($value['attributes']) && is_array($value['attributes'])) {
889
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
890 891
        }

892
        if (isset($value['value']) && $value['value'] != '') {
893
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
894 895 896 897 898 899 900
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
901
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
902
    }
Dries's avatar
 
Dries committed
903
  }
Dries's avatar
 
Dries committed
904 905 906
  return $output;
}

Dries's avatar
 
Dries committed
907
/**
908
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
909
 *
Dries's avatar
 
Dries committed
910
 * This function ensures that the string is pluralized correctly. Since t() is
911 912
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
913
 *
914 915 916 917 918 919 920 921 922 923
 * 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.',
924
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
925 926
 * @endcode
 *
Dries's avatar
 
Dries committed
927 928 929
 * @param $count
 *   The item count to display.
 * @param $singular
930 931 932
 *   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
933
 * @param $plural
934 935 936
 *   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".
937
 * @param $args
938
 *   An associative array of replacements to make after translation. Instances
939
 *   of any key in this array are replaced with the corresponding value.
940 941 942
 *   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.
943
 * @param $options
944 945
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
946 947
 * @return
 *   A translated string.
948 949 950
 *
 * @see t()
 * @see format_string()
Dries's avatar
 
Dries committed
951
 */
952
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
953
  $args['@count'] = $count;
954 955 956 957 958 959 960
  // 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);

961
  if ($count == 1) {
962
    return $translated_array[0];
963
  }
Dries's avatar
 
Dries committed
964

965
  // Get the plural index through the gettext formula.
966
  // @todo implement static variable to minimize function_exists() usage.
967
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
968 969 970
  if ($index == 0) {
    // Singular form.
    return $translated_array[0];
Dries's avatar
 
Dries committed
971 972
  }
  else {
973 974 975 976 977 978 979 980 981
    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
982 983
    }
  }
Dries's avatar
 
Dries committed
984 985
}

986
/**