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

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

31 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
/**
 * @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
 *
59
 * @}
60 61
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $profile;
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/**
499
 * Parses a system URL string into an associative array suitable for url().
500 501
 *
 * This function should only be used for URLs that have been generated by the
502 503
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
504 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
 *
 * 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
530 531
 *
 * @deprecated as of Drupal 8.0. Use Url::parse() instead.
532 533
 */
function drupal_parse_url($url) {
534
  return Url::parse($url);
535 536 537
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $output;
}

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

  return $output;
}

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

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

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

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

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

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

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

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

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

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