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

3
use Drupal\Component\Utility\Crypt;
4 5 6
use Drupal\Component\Utility\String;
use Drupal\Component\Utility\UrlValidator;
use Drupal\Component\Utility\Xss;
7
use Drupal\Core\Cache\Cache;
8
use Drupal\Core\Language\Language;
9
use Symfony\Component\DependencyInjection\Container;
10
use Symfony\Component\Yaml\Parser;
11 12
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
13
use Drupal\Component\PhpStorage\PhpStorageFactory;
14
use Drupal\Component\Utility\NestedArray;
15
use Drupal\Core\Cache\CacheBackendInterface;
16
use Drupal\Core\Datetime\DrupalDateTime;
17
use Drupal\Core\Database\Database;
18
use Drupal\Core\Routing\GeneratorNotInitializedException;
19
use Drupal\Core\SystemListingInfo;
20
use Drupal\Core\Template\Attribute;
21

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

30 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
/**
 * @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
 *
58
 * @}
59 60
 */

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

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

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

76
/**
77
 * The default aggregation group for system CSS files added to the page.
78
 */
79
const CSS_AGGREGATE_SYSTEM = -100;
80 81

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

/**
87
 * The default aggregation group for theme CSS files added to the page.
88
 */
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
const CSS_AGGREGATE_THEME = 100;

/**
 * The default weight for CSS rules that style HTML elements ("base" styles).
 */
const CSS_BASE = -200;

/**
 * The default weight for CSS rules that layout a page.
 */
const CSS_LAYOUT = -100;

/**
 * The default weight for CSS rules that style design components (and their associated states and skins.)
 */
const CSS_COMPONENT = 0;

/**
 * The default weight for CSS rules that style states and are not included with components.
 */
const CSS_STATE = 100;

/**
 * The default weight for CSS rules that style skins and are not included with components.
 */
const CSS_SKIN = 200;
115

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

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

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

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

136
/**
137 138 139
 * @defgroup block_caching Block Caching
 * @{
 * Constants that define each block's caching state.
140
 *
141 142 143 144 145 146 147 148 149 150
 * Modules specify how their blocks can be cached in their hook_block_info()
 * implementations. Caching can be turned off (DRUPAL_NO_CACHE), managed by the
 * module declaring the block (DRUPAL_CACHE_CUSTOM), or managed by the core
 * Block module. If the Block module is managing the cache, you can specify that
 * the block is the same for every page and user (DRUPAL_CACHE_GLOBAL), or that
 * it can change depending on the page (DRUPAL_CACHE_PER_PAGE) or by user
 * (DRUPAL_CACHE_PER_ROLE or DRUPAL_CACHE_PER_USER). Page and user settings can
 * be combined with a bitwise-binary or operator; for example,
 * DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE means that the block can change
 * depending on the user role or page it is on.
151
 *
152 153
 * The block cache is cleared when the 'content' cache tag is invalidated,
 * following the same pattern as the page cache (node, comment, user, taxonomy
154
 * added or updated...).
155 156 157 158 159
 *
 * Note that user 1 is excluded from block caching.
 */

/**
160 161 162 163 164 165 166
 * The block should not get cached.
 *
 * This setting should be used:
 * - For simple blocks (notably those that do not perform any db query), where
 *   querying the db cache would be more expensive than directly generating the
 *   content.
 * - For blocks that change too frequently.
167
 */
168
const DRUPAL_NO_CACHE = -1;
169 170

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

/**
179 180 181 182
 * The block or element can change depending on the user's roles.
 *
 * This is the default setting for blocks, used when the block does not specify
 * anything.
183
 */
184
const DRUPAL_CACHE_PER_ROLE = 0x0001;
185 186

/**
187 188
 * The block or element can change depending on the user.
 *
189 190 191
 * This setting can be resource-consuming for sites with large number of users,
 * and thus should only be used when DRUPAL_CACHE_PER_ROLE is not sufficient.
 */
192
const DRUPAL_CACHE_PER_USER = 0x0002;
193 194 195 196

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

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

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

208 209 210 211 212 213 214 215 216
/**
 * The delimiter used to split plural strings.
 *
 * This is the ETX (End of text) character and is used as a minimal means to
 * separate singular and plural variants in source and translation text. It
 * was found to be the most compatible delimiter for the supported databases.
 */
const LOCALE_PLURAL_DELIMITER = "\03";

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

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

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

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

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

  return $profile;
}


Dries's avatar
 
Dries committed
286
/**
287
 * Sets the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
288
 *
Dries's avatar
 
Dries committed
289 290 291
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
292
 */
Dries's avatar
 
Dries committed
293
function drupal_set_breadcrumb($breadcrumb = NULL) {
294
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
 
Dries committed
295

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

Dries's avatar
 
Dries committed
302
/**
303
 * Gets the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
304
 */
Dries's avatar
 
Dries committed
305 306 307
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

308
  if (!isset($breadcrumb)) {
Dries's avatar
 
Dries committed
309 310 311 312 313 314
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

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

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

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

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

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

404
  if (isset($url)) {
405
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
406

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

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

Dries's avatar
 
Dries committed
430
/**
431
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
432
 * @{
Dries's avatar
 
Dries committed
433
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
434 435
 */

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

463
  $params = array();
464
  foreach ($query as $key => $value) {
465 466 467
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
468 469
    }

470 471 472 473 474
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
475
    }
476 477 478 479 480
  }

  return $params;
}

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

501
/**
502
 * Parses an array into a valid, rawurlencoded query string.
503
 *
504
 * @see \Drupal\Core\Routing\PathBasedGeneratorInterface::httpBuildQuery()
505
 * @see drupal_get_query_parameters()
506 507
 * @deprecated as of Drupal 8.0. Use
 *   Drupal::urlGenerator()->httpBuildQuery() instead.
508 509 510
 * @ingroup php_wrappers
 */
function drupal_http_build_query(array $query, $parent = '') {
511
  return Drupal::urlGenerator()->httpBuildQuery($query, $parent);
512 513
}

514
/**
515
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
516
 *
517 518 519 520
 * 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.
521
 *
522 523 524 525 526 527
 * @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()
528 529 530
 * @see drupal_goto()
 */
function drupal_get_destination() {
531 532 533 534 535 536
  $destination = &drupal_static(__FUNCTION__);

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

537
  if (isset($_GET['destination'])) {
538
    $destination = array('destination' => $_GET['destination']);
539 540
  }
  else {
541
    $path = current_path();
542
    $query = Drupal::urlGenerator()->httpBuildQuery(drupal_get_query_parameters());
543
    if ($query != '') {
544
      $path .= '?' . $query;
545
    }
546 547 548 549 550 551
    $destination = array('destination' => $path);
  }
  return $destination;
}

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

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

  return $options;
}

/**
627
 * Encodes a Drupal path for use in a URL.
628
 *
629
 * For aesthetic reasons slashes are not escaped.
630
 *
631 632
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
633 634
 *
 * @param $path
635
 *   The Drupal path to encode.
636 637
 */
function drupal_encode_path($path) {
638
  return str_replace('%2F', '/', rawurlencode($path));
639 640
}

Kjartan's avatar
Kjartan committed
641
/**
642
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
643
 *
Dries's avatar
 
Dries committed
644 645
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
646
 *
647 648 649 650 651 652
 * If a destination was specified in the current request's URI (i.e.,
 * $_GET['destination']) then it will override the $path and $options values
 * passed to this function. This provides the flexibility to build a link to
 * user/login and override the default redirection so that the user is
 * redirected to a specific path after logging in:
 * @code
653 654
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
655
 * @endcode
656
 *
657 658
 * Drupal will ensure that messages set by drupal_set_message() and other
 * session data are written to the database before the user is redirected.
Dries's avatar
 
Dries committed
659
 *
660 661
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
 
Dries committed
662 663
 *
 * @param $path
664 665
 *   (optional) A Drupal path or a full URL, which will be passed to url() to
 *   compute the redirect for the URL.
666
 * @param $options
667
 *   (optional) An associative array of additional URL options to pass to url().
668
 * @param $http_response_code
669 670
 *   (optional) The HTTP status code to use for the redirection, defaults to
 *   302. The valid values for 3xx redirection status codes are defined in
671 672 673 674 675 676 677 678 679 680
 *   @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3 RFC 2616 @endlink
 *   and the
 *   @link http://tools.ietf.org/html/draft-reschke-http-status-308-07 draft for the new HTTP status codes: @endlink
 *   - 301: Moved Permanently (the recommended value for most redirects).
 *   - 302: Found (default in Drupal and PHP, sometimes used for spamming search
 *     engines).
 *   - 303: See Other.
 *   - 304: Not Modified.
 *   - 305: Use Proxy.
 *   - 307: Temporary Redirect.
681
 *
682
 * @see drupal_get_destination()
683
 * @see url()
Kjartan's avatar
Kjartan committed
684
 */
685 686
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
687 688
  // We do not allow absolute URLs to be passed via $_GET, as this can be an
  // attack vector, with the following exception:
689 690
  // - Absolute URLs that point to this site (i.e. same base URL and
  //   base path) are allowed.
691
  if (isset($_GET['destination']) && (!url_is_external($_GET['destination']) || _external_url_is_local($_GET['destination']))) {
692
    $destination = drupal_parse_url($_GET['destination']);
693 694 695
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
696 697
  }

698 699 700 701
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

  // The 'Location' HTTP header must be absolute.
  $options['absolute'] = TRUE;
702

703
  $url = Drupal::urlGenerator()->generateFromPath($path, $options);
704
  header('Location: ' . $url, TRUE, $http_response_code);
705 706

  // The "Location" header sends a redirect status code to the HTTP daemon. In
707 708
  // some cases this can be wrong, so we make sure none of the code below the
  // drupal_goto() call gets executed upon redirection.
709
  drupal_exit();
Kjartan's avatar
Kjartan committed
710 711
}

712 713 714 715 716 717 718 719 720 721
/**
 * Determines if an external URL points to this Drupal installation.
 *
 * @param $url
 *   A string containing an external URL, such as "http://example.com/foo".
 *
 * @return
 *   TRUE if the URL has the same domain and base path.
 */
function _external_url_is_local($url) {
722 723
  $url_parts = parse_url($url);
  $base_host = parse_url($GLOBALS['base_url'], PHP_URL_HOST);
724

725 726 727 728
  if (!isset($url_parts['path'])) {
    return ($url_parts['host'] == $base_host);
  }
  else {
729 730 731 732
    // When comparing base paths, we need a trailing slash to make sure a
    // partial URL match isn't occuring. Since base_path() always returns with
    // a trailing slash, we don't need to add the trailing slash here.
    return ($url_parts['host'] == $base_host && stripos($url_parts['path'], base_path()) === 0);
733
  }
734 735
}

736 737 738 739 740 741 742
/**
 * 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) {
743
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
744 745 746
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
 
Dries committed
747
/**
748
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
749
 */
Dries's avatar
 
Dries committed
750

Kjartan's avatar
Kjartan committed
751
/**
Dries's avatar
 
Dries committed
752
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
753
 * @{
Dries's avatar
 
Dries committed
754
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
755 756
 */

757
/**
758
 * Verifies the syntax of the given e-mail address.
Dries's avatar
 
Dries committed
759
 *
760 761
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
762
 *
Dries's avatar
 
Dries committed
763
 * @param $mail
764
 *   A string containing an e-mail address.
765
 *
Dries's avatar
 
Dries committed
766
 * @return
Dries's avatar
 
Dries committed
767
 *   TRUE if the address is in a valid format.
768
 */
Dries's avatar
 
Dries committed
769
function valid_email_address($mail) {
770
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
771 772
}

Dries's avatar
 
Dries committed
773
/**
774
 * Verifies the syntax of the given URL.
Dries's avatar
 
Dries committed
775
 *
776 777
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
778
 * Valid values per RFC 3986.
Dries's avatar
 
Dries committed
779
 * @param $url
Dries's avatar
 
Dries committed
780
 *   The URL to verify.
Dries's avatar
 
Dries committed
781
 * @param $absolute
Dries's avatar
 
Dries committed
782
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
783
 *
Dries's avatar
 
Dries committed
784
 * @return
Dries's avatar
 
Dries committed
785
 *   TRUE if the URL is in a valid format.
786 787
 *
 * @see \Drupal\Component\Utility\UrlValidator::isValid()
Dries's avatar
 
Dries committed
788
 */
Dries's avatar
 
Dries committed
789
function valid_url($url, $absolute = FALSE) {
790
  return UrlValidator::isValid($url, $absolute);
Dries's avatar
 
Dries committed
791 792
}

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
/**
 * 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);
}

839 840 841 842
/**
 * @} End of "defgroup validation".
 */

843 844 845 846
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
847 848 849
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
850 851
 */

Dries's avatar
Dries committed
852
/**
853 854 855 856 857 858
 * 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
859 860 861
 * be a plain-text string for passing to t(), l(),
 * Drupal\Core\Template\Attribute, or another function that will call
 * check_plain() separately.
862 863 864 865 866 867 868 869 870 871
 *
 * @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.
 *
872
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
873 874
 */
function drupal_strip_dangerous_protocols($uri) {
875
  return UrlValidator::stripDangerousProtocols($uri);
876 877 878
}

/**
879
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
880 881 882 883 884 885 886
 *
 * @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
887 888 889 890 891
 *   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.
892
 *
893 894
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
895 896
 */
function check_url($uri) {
897
  return String::checkPlain(UrlValidator::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
898 899
}

900
/**
901
 * Applies a very permissive XSS/HTML filter for admin-only use.
902 903 904 905 906 907 908
 *
 * 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.
909 910 911 912 913 914 915 916
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
917 918
 */
function filter_xss_admin($string) {
919
  return Xss::filterAdmin($string);
920 921 922
}

/**
923
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
924
 *
925 926
 * 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.
927 928
 *
 * This code does four things:
929 930 931 932 933
 * - 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:).
934 935
 *
 * @param $string
936 937
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
938 939
 * @param $allowed_tags
 *   An array of allowed tags.
940 941 942 943 944
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
945 946
 * @see \Drupal\Component\Utility\Xss::filter()
 *
947
 * @ingroup sanitization
948 949
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
950
  return Xss::filter($string, $allowed_tags);
951 952 953
}

/**
954
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
955
 *
956
 * @param string $string
957
 *   The string with the attribute value.
958
 *
959
 * @return string
960
 *   Cleaned up and HTML-escaped version of $string.
961 962
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
963
 */
964 965
function filter_xss_bad_protocol($string) {
  return UrlValidator::filterBadProtocol($string);
966 967 968 969 970 971
}

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

Dries's avatar
 
Dries committed
972
/**
Dries's avatar
 
Dries committed
973
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
974
 * @{
Dries's avatar
 
Dries committed
975
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
976 977
 */

Dries's avatar
 
Dries committed
978 979 980 981 982
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
983
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
984
  $langcode = $langcode ? $langcode : language(Language::TYPE_CONTENT)->langcode;
Dries's avatar
 
Dries committed
985

Dries's avatar
Dries committed
986
  $output = "<channel>\n";
987 988
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
989 990 991 992

  // 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;).
993 994
  $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . check_plain($langcode) . "</language>\n";
995
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
996 997 998 999 1000 1001
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
1002
/**
1003
 * Formats a single RSS item.
Dries's avatar
 
Dries committed
1004 1005 1006
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
1007
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
1008
  $output = "<item>\n";
1009 1010 1011
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
  $output .= ' <description>' . check_plain($description) . "</description>\n";
1012 1013 1014 1015 1016 1017 1018
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
1019
 * Formats XML elements.
1020 1021
 *
 * @param $array
1022
 *   An array where each item represents an element and is either a: