common.inc 180 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\SortArray;
6
use Drupal\Component\Utility\String;
7
use Drupal\Component\Utility\Tags;
8
use Drupal\Component\Utility\Url;
9
use Drupal\Component\Utility\Xss;
10
use Drupal\Core\Cache\Cache;
11
use Drupal\Core\Language\Language;
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\Core\Cache\CacheBackendInterface;
19
use Drupal\Core\Datetime\DrupalDateTime;
20
use Drupal\Core\Routing\GeneratorNotInitializedException;
21
use Drupal\Core\SystemListingInfo;
22
use Drupal\Core\Template\Attribute;
23

Dries's avatar
 
Dries committed
24 25 26 27 28 29 30 31
/**
 * @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.
 */

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
/**
 * @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
 *
60
 * @}
61 62
 */

63 64 65
/**
 * Return status for saving which involved creating a new item.
 */
66
const SAVED_NEW = 1;
67 68 69 70

/**
 * Return status for saving which involved an update to an existing item.
 */
71
const SAVED_UPDATED = 2;
72 73 74 75

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

78
/**
79
 * The default aggregation group for CSS files added to the page.
80
 */
81
const CSS_AGGREGATE_DEFAULT = 0;
82 83

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

113 114 115 116 117
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

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

/**
124
 * The default group for module JavaScript code added to the page.
125
 */
126
const JS_DEFAULT = 0;
127 128

/**
129
 * The default group for theme JavaScript code added to the page.
130
 */
131
const JS_THEME = 100;
132

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

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

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

/**
176 177 178 179
 * 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.
180
 */
181
const DRUPAL_CACHE_PER_ROLE = 0x0001;
182 183

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

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

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

201 202 203 204
/**
 * @} End of "defgroup block_caching".
 */

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

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

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

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

257
/**
258
 * Gets the name of the currently active installation profile.
259 260 261 262
 *
 * 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
263 264
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
265 266
 *
 * @return $profile
267
 *   The name of the installation profile.
268 269 270 271 272 273 274 275
 */
function drupal_get_profile() {
  global $install_state;

  if (isset($install_state['parameters']['profile'])) {
    $profile = $install_state['parameters']['profile'];
  }
  else {
276
    $profile = variable_get('install_profile', 'standard');
277 278 279 280 281 282
  }

  return $profile;
}


Dries's avatar
 
Dries committed
283
/**
284
 * Sets the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
285
 *
Dries's avatar
 
Dries committed
286 287 288
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
289 290 291 292 293
 *
 * @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
294
 */
Dries's avatar
 
Dries committed
295
function drupal_set_breadcrumb($breadcrumb = NULL) {
296
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
 
Dries committed
297

298
  if (isset($breadcrumb)) {
Dries's avatar
 
Dries committed
299 300 301 302 303
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

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

325 326 327 328 329 330 331 332 333 334
  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
335 336 337 338
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
339
/**
340 341 342 343 344 345 346 347 348 349
 * 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(
350
      'charset' => 'utf-8',
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
    ),
    // 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;
}

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

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

393
  if (isset($url)) {
394
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
395

396 397 398 399 400 401 402 403
    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)),
    ));
404 405 406 407 408
  }
  return $stored_feed_links;
}

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

Dries's avatar
 
Dries committed
419
/**
420
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
421
 * @{
Dries's avatar
 
Dries committed
422
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
423 424
 */

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

448
/**
449
 * Parses an array into a valid, rawurlencoded query string.
450
 *
webchick's avatar
webchick committed
451
 * @see \Drupal\Core\Routing\PathBasedGeneratorInterface::httpBuildQuery()
452
 * @see drupal_get_query_parameters()
453
 * @deprecated as of Drupal 8.0. Use Url::buildQuery() instead.
454
 * @ingroup php_wrappers
455 456
 *
 * @deprecated as of Drupal 8.0. Use Url::buildQuery() instead.
457 458
 */
function drupal_http_build_query(array $query, $parent = '') {
459
  return Url::buildQuery($query, $parent);
460 461
}

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

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

484 485 486
  $query = Drupal::request()->query;
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
487 488
  }
  else {
489
    $path = current_path();
490
    $query = Url::buildQuery(Url::filterQueryParameters($query->all()));
491
    if ($query != '') {
492
      $path .= '?' . $query;
493
    }
494 495 496 497 498 499
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
500
 * Parses a system URL string into an associative array suitable for url().
501 502
 *
 * This function should only be used for URLs that have been generated by the
503 504
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
 *
 * 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
531 532
 *
 * @deprecated as of Drupal 8.0. Use Url::parse() instead.
533 534
 */
function drupal_parse_url($url) {
535
  return Url::parse($url);
536 537 538
}

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

555 556 557 558 559 560 561 562
/**
 * 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.
563 564
 *
 * @deprecated as of Drupal 8.0. Use Url::externalIsLocal() instead.
565 566
 */
function _external_url_is_local($url) {
567
  return Url::externalIsLocal($url, base_path());
568 569
}

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

Dries's avatar
 
Dries committed
581
/**
582
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
583
 */
Dries's avatar
 
Dries committed
584

Kjartan's avatar
Kjartan committed
585
/**
Dries's avatar
 
Dries committed
586
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
587
 * @{
Dries's avatar
 
Dries committed
588
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
589 590
 */

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

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

629 630 631 632 633 634 635 636 637 638 639 640 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
/**
 * 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);
}

675 676 677 678
/**
 * @} End of "defgroup validation".
 */

679 680 681 682
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
683 684 685
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
686 687
 */

Dries's avatar
Dries committed
688
/**
689 690 691 692 693 694
 * 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
695 696 697
 * be a plain-text string for passing to t(), l(),
 * Drupal\Core\Template\Attribute, or another function that will call
 * check_plain() separately.
698 699 700 701 702 703 704 705 706 707
 *
 * @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.
 *
708
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
709 710
 */
function drupal_strip_dangerous_protocols($uri) {
711
  return Url::stripDangerousProtocols($uri);
712 713 714
}

/**
715
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
716 717 718 719 720 721 722
 *
 * @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
723 724 725 726 727
 *   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.
728
 *
729 730
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
731 732
 */
function check_url($uri) {
733
  return String::checkPlain(Url::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
734 735
}

736
/**
737
 * Applies a very permissive XSS/HTML filter for admin-only use.
738 739 740 741 742 743 744
 *
 * 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.
745 746 747 748 749 750 751 752
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
753 754
 */
function filter_xss_admin($string) {
755
  return Xss::filterAdmin($string);
756 757 758
}

/**
759
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
760
 *
761 762
 * 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.
763 764
 *
 * This code does four things:
765 766 767 768 769
 * - 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:).
770 771
 *
 * @param $string
772 773
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
774 775
 * @param $allowed_tags
 *   An array of allowed tags.
776 777 778 779 780
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
781 782
 * @see \Drupal\Component\Utility\Xss::filter()
 *
783
 * @ingroup sanitization
784 785
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
786
  return Xss::filter($string, $allowed_tags);
787 788 789
}

/**
790
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
791
 *
792
 * @param string $string
793
 *   The string with the attribute value.
794
 *
795
 * @return string
796
 *   Cleaned up and HTML-escaped version of $string.
797 798
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
799
 */
800
function filter_xss_bad_protocol($string) {
801
  return Url::filterBadProtocol($string);
802 803 804 805 806 807
}

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

Dries's avatar
 
Dries committed
808
/**
Dries's avatar
 
Dries committed
809
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
810
 * @{
Dries's avatar
 
Dries committed
811
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
812 813
 */

Dries's avatar
 
Dries committed
814 815 816 817 818
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
819
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
820
  $langcode = $langcode ? $langcode : language(Language::TYPE_CONTENT)->id;
Dries's avatar
 
Dries committed
821

Dries's avatar
Dries committed
822
  $output = "<channel>\n";
823 824
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
825 826 827 828

  // 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;).
829 830
  $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . check_plain($langcode) . "</language>\n";
831
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
832 833 834 835 836 837
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
838
/**
839
 * Formats a single RSS item.
Dries's avatar
 
Dries committed
840 841 842
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
843
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
844
  $output = "<item>\n";
845 846 847
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
  $output .= ' <description>' . check_plain($description) . "</description>\n";
848 849 850 851 852 853 854
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
855
 * Formats XML elements.
856 857
 *
 * @param $array
858
 *   An array where each item represents an element and is either a:
859 860 861 862 863 864 865 866 867 868
 *   - (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) {
869
  $output = '';
870 871
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
872
      if ($value['key']) {
873
        $output .= ' <' . $value['key'];
874
        if (isset($value['attributes']) && is_array($value['attributes'])) {
875
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
876 877
        }

878
        if (isset($value['value']) && $value['value'] != '') {
879
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
880 881 882 883 884 885 886
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
887
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
888
    }
Dries's avatar
 
Dries committed
889
  }
Dries's avatar
 
Dries committed
890 891 892
  return $output;
}

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

947
  if ($count == 1) {
948
    return $translated_array[0];
949
  }
Dries's avatar
 
Dries committed
950

951
  // Get the plural index through the gettext formula.
952
  // @todo implement static variable to minimize function_exists() usage.
953
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
954 955 956
  if ($index == 0) {
    // Singular form.
    return $translated_array[0];
Dries's avatar
 
Dries committed
957 958
  }
  else {
959 960 961 962 963 964 965 966 967
    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
968 969
    }
  }
Dries's avatar
 
Dries committed
970 971
}

972
/**
973
 * Parses a given byte count.
974 975
 *
 * @param $size
976 977
 *   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).
978
 *
979
 * @return
980
 *   An integer representation of the size in bytes.
981 982
 */
function parse_size($size) {
983 984 985 986 987 988 989 990
  $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);
991 992 993
  }
}

Dries's avatar
 
Dries committed
994
/**
995
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
996
 *
Dries's avatar
 
Dries committed
997
 * @param $size
998
 *   A size in bytes.
999
 * @param $langcode
1000 1001
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
1002
 *
Dries's avatar
 
Dries committed
1003 1004
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
1005
 */
1006
function format_size($size, $langcode = NULL) {
1007
  if ($size < DRUPAL_KILOBYTE) {
1008
    return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
1009
  }
1010
  else {
1011
    $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
1012
    $units = array(
1013 1014 1015 1016 1017 1018 1019 1020
      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)),
1021 1022
    );
    foreach ($units as $unit) {
1023 1024
      if (round($size, 2) >= DRUPAL_KILOBYTE) {
        $size = $size / DRUPAL_KILOBYTE;
1025 1026 1027 1028
      }
      else {
        break;
      }
1029
    }
1030
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
1031 1032 1033
  }
}

Dries's avatar
 
Dries committed
1034
/**
1035
 * Formats a time interval with the requested granularity.
Dries's avatar
 
Dries committed
1036
 *
1037
 * @param $interval
Dries's avatar
 
Dries committed
1038 1039 1040
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
1041 1042 1043
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
1044
 *
Dries's avatar
 
Dries committed
1045 1046
 * @return
 *   A translated string representation of the interval.
Dries's avatar
 
Dries committed
1047
 */
1048
function format_interval($interval, $granularity = 2, $langcode = NULL) {
1049 1050 1051 1052 1053 1054 1055 1056 1057
  $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
1058
  $output = '';
Dries's avatar
 
Dries committed
1059
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
1060
    $key = explode('|', $key);
1061 1062 1063
    if ($interval >= $value) {
      $output .= ($output ? ' ' : '') . format_plural(floor($interval / $value), $key[0], $key[1], array(), array('langcode' => $langcode));
      $interval %= $value;
Dries's avatar
 
Dries committed
1064 1065 1066 1067 1068
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
1069 1070
    }
  }
1071
  return $output ? $output : t('0 sec', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
1072 1073
}

Dries's avatar
 
Dries committed
1074
/**
1075
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
1076
 *
Dries's avatar
 
Dries committed
1077
 * @param $timestamp
1078
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
1079
 * @param $type
1080
 *   (optional) The format to use, one of:
1081 1082 1083 1084 1085
 *   - 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.