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

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

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

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 60 61
/**
 * @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
 *
62
 * @}
63 64
 */

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

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

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

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

/**
86
 * The default aggregation group for theme CSS files added to the page.
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 112 113
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;
114

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $profile;
}


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

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

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

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

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

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

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

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

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

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

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

427
/**
428
 * Processes a URL query parameter array to remove unwanted elements.
429 430
 *
 * @param $query
431
 *   (optional) An array to be processed. Defaults to $_GET.
432
 * @param $exclude
433
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
434
 *   exclude nested items.
435
 * @param $parent
436 437
 *   Internal use only. Used to build the $query array key for nested items.
 *
438
 * @return
439
 *   An array containing query parameters, which can be used for url().
440
 */
441
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
442 443 444 445 446 447 448 449 450 451 452
  // 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);
  }
453

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

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

  return $params;
}

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

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

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

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

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

/**
543
 * Parses a system URL string into an associative array suitable for url().
544 545
 *
 * This function should only be used for URLs that have been generated by the
546 547
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
 *
 * The returned array contains a 'path' that may be passed separately to url().
 * For example:
 * @code
 *   $options = drupal_parse_url($_GET['destination']);
 *   $my_url = url($options['path'], $options);
 *   $my_link = l('Example link', $options['path'], $options);
 * @endcode
 *
 * This is required, because url() does not support relative URLs containing a
 * query string or fragment in its $path argument. Instead, any query string
 * needs to be parsed into an associative query parameter array in
 * $options['query'] and the fragment into $options['fragment'].
 *
 * @param $url
 *   The URL string to parse, f.e. $_GET['destination'].
 *
 * @return
 *   An associative array containing the keys:
 *   - 'path': The path of the URL. If the given $url is external, this includes
 *     the scheme and host.
 *   - 'query': An array of query parameters of $url, if existent.
 *   - 'fragment': The fragment of $url, if existent.
 *
 * @see url()
 * @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 {
601 602 603 604 605
    // parse_url() does not support relative URLs, so make it absolute. E.g. the
    // relative URL "foo/bar:1" isn't properly parsed.
    $parts = parse_url('http://example.com/' . $url);
    // Strip the leading slash that was just added.
    $options['path'] = substr($parts['path'], 1);
606 607 608 609 610 611 612 613 614 615 616 617
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

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

Kjartan's avatar
Kjartan committed
632
/**
633
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
634
 *
Dries's avatar
 
Dries committed
635 636
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
637
 *
638 639 640 641 642 643
 * 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
644 645
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
646
 * @endcode
647
 *
648 649
 * 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
650
 *
651 652
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
 
Dries committed
653 654
 *
 * @param $path
655 656
 *   (optional) A Drupal path or a full URL, which will be passed to url() to
 *   compute the redirect for the URL.
657
 * @param $options
658
 *   (optional) An associative array of additional URL options to pass to url().
659
 * @param $http_response_code
660 661
 *   (optional) The HTTP status code to use for the redirection, defaults to
 *   302. The valid values for 3xx redirection status codes are defined in
662 663 664 665 666 667 668 669 670 671
 *   @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.
672
 *
673
 * @see drupal_get_destination()
674
 * @see url()
Kjartan's avatar
Kjartan committed
675
 */
676 677
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
678 679
  // We do not allow absolute URLs to be passed via $_GET, as this can be an
  // attack vector, with the following exception:
680 681
  // - Absolute URLs that point to this site (i.e. same base URL and
  //   base path) are allowed.
682
  if (isset($_GET['destination']) && (!url_is_external($_GET['destination']) || _external_url_is_local($_GET['destination']))) {
683
    $destination = drupal_parse_url($_GET['destination']);
684 685 686
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
687 688
  }

689 690 691 692
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

694
  $url = Drupal::urlGenerator()->generateFromPath($path, $options);
695 696 697 698 699 700 701 702

  if (drupal_get_bootstrap_phase() == DRUPAL_BOOTSTRAP_FULL) {
    drupal_session_commit();
  }

  $response = new RedirectResponse($url, $http_response_code);
  // @todo We should not send the response here: http://drupal.org/node/1668866
  $response->sendHeaders();
703 704

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

710 711 712 713 714 715 716 717 718 719
/**
 * 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) {
720 721
  $url_parts = parse_url($url);
  $base_host = parse_url($GLOBALS['base_url'], PHP_URL_HOST);
722

723 724 725 726
  if (!isset($url_parts['path'])) {
    return ($url_parts['host'] == $base_host);
  }
  else {
727 728 729 730
    // 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);
731
  }
732 733
}

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

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

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

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

Dries's avatar
 
Dries committed
771
/**
772
 * Verifies the syntax of the given URL.
Dries's avatar
 
Dries committed
773
 *
774 775
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
776
 * Valid values per RFC 3986.
Dries's avatar
 
Dries committed
777
 * @param $url
Dries's avatar
 
Dries committed
778
 *   The URL to verify.
Dries's avatar
 
Dries committed
779
 * @param $absolute
Dries's avatar
 
Dries committed
780
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
781
 *
Dries's avatar
 
Dries committed
782
 * @return
Dries's avatar
 
Dries committed
783
 *   TRUE if the URL is in a valid format.
784 785
 *
 * @see \Drupal\Component\Utility\UrlValidator::isValid()
786 787
 *
 * @deprecated as of Drupal 8.0. Use UrlValidator::isValid() instead.
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:
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
 *   - (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) {
1033
  $output = '';
1034 1035
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
1036
      if ($value['key']) {
1037
        $output .= ' <' . $value['key'];
1038
        if (isset($value['attributes']) && is_array($value['attributes'])) {
1039
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
1040 1041
        }

1042
        if (isset($value['value']) && $value['value'] != '') {
1043
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
1044 1045 1046 1047 1048 1049 1050
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
1051
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
1052
    }
Dries's avatar
 
Dries committed
1053
  }
Dries's avatar
 
Dries committed
1054 1055 1056
  return $output;
}

Dries's avatar
 
Dries committed
1057
/**
1058
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
1059
 *
Dries's avatar
 
Dries committed
1060
 * This function ensures that the string is pluralized correctly. Since t() is
1061 1062
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
1063
 *
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
 * 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.',
1074
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
1075 1076
 * @endcode
 *
Dries's avatar
 
Dries committed
1077 1078 1079
 * @param $count
 *   The item count to display.
 * @param $singular
1080 1081 1082
 *   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
1083
 * @param $plural
1084 1085 1086
 *   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".
1087
 * @param $args
1088
 *   An associative array of replacements to make after translation. Instances
1089
 *   of any key in this array are replaced with the corresponding value.
1090 1091 1092
 *   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.
1093
 * @param $options
1094 1095
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
1096 1097
 * @return
 *   A translated string.
1098 1099 1100
 *
 * @see t()
 * @see format_string()
Dries's avatar
 
Dries committed
1101
 */
1102
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
1103
  $args['@count'] = $count;
1104 1105 1106 1107 1108 1109 1110
  // 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);

1111
  if ($count == 1) {
1112
    return $translated_array[0];
1113
  }
Dries's avatar
 
Dries committed
1114

1115
  // Get the plural index through the gettext formula.
1116
  // @todo implement static variable to minimize function_exists() usage.
1117
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
1118 1119 1120
  if ($index == 0) {
    // Singular form.
    return $translated_array[0];
Dries's avatar
 
Dries committed
1121 1122
  }
  else {
1123 1124 1125 1126 1127 1128 1129 1130 1131
    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
1132 1133
    }
  }
Dries's avatar
 
Dries committed
1134 1135
}

1136
/**
1137
 * Parses a given byte count.
1138 1139
 *
 * @param $size
1140 1141
 *   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).