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.
Kjartan's avatar
Kjartan committed
291
 */
Dries's avatar
 
Dries committed
292
function drupal_set_breadcrumb($breadcrumb = NULL) {
293
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
 
Dries committed
294

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

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

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

  return $breadcrumb;
}

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

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

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

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

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

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

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

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

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

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

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

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

  return $params;
}

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

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

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

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

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

/**
551
 * Parses a system URL string into an associative array suitable for url().
552 553
 *
 * This function should only be used for URLs that have been generated by the
554 555
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
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 601 602 603 604 605 606 607 608
 *
 * 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 {
609 610 611 612 613
    // 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);
614 615 616 617 618 619 620 621 622 623 624 625
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

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

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

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

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

702
  $url = Drupal::urlGenerator()->generateFromPath($path, $options);
703 704 705 706 707 708 709 710

  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();
711 712

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

718 719 720 721 722 723 724 725 726 727
/**
 * 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) {
728 729
  $url_parts = parse_url($url);
  $base_host = parse_url($GLOBALS['base_url'], PHP_URL_HOST);
730

731 732 733 734
  if (!isset($url_parts['path'])) {
    return ($url_parts['host'] == $base_host);
  }
  else {
735 736 737 738
    // 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);
739
  }
740 741
}

742 743 744 745 746 747 748
/**
 * 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) {
749
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
750 751 752
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
 
Dries committed
753
/**
754
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
755
 */
Dries's avatar
 
Dries committed
756

Kjartan's avatar
Kjartan committed
757
/**
Dries's avatar
 
Dries committed
758
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
759
 * @{
Dries's avatar
 
Dries committed
760
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
761 762
 */

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

Dries's avatar
 
Dries committed
779
/**
780
 * Verifies the syntax of the given URL.
Dries's avatar
 
Dries committed
781
 *
782 783
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
784
 * Valid values per RFC 3986.
Dries's avatar
 
Dries committed
785
 * @param $url
Dries's avatar
 
Dries committed
786
 *   The URL to verify.
Dries's avatar
 
Dries committed
787
 * @param $absolute
Dries's avatar
 
Dries committed
788
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
789
 *
Dries's avatar
 
Dries committed
790
 * @return
Dries's avatar
 
Dries committed
791
 *   TRUE if the URL is in a valid format.
792 793
 *
 * @see \Drupal\Component\Utility\UrlValidator::isValid()
794 795
 *
 * @deprecated as of Drupal 8.0. Use UrlValidator::isValid() instead.
Dries's avatar
 
Dries committed
796
 */
Dries's avatar
 
Dries committed
797
function valid_url($url, $absolute = FALSE) {
798
  return UrlValidator::isValid($url, $absolute);
Dries's avatar
 
Dries committed
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 839 840 841 842 843 844 845 846
/**
 * 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);
}

847 848 849 850
/**
 * @} End of "defgroup validation".
 */

851 852 853 854
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
855 856 857
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
858 859
 */

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

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

908
/**
909
 * Applies a very permissive XSS/HTML filter for admin-only use.
910 911 912 913 914 915 916
 *
 * 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.
917 918 919 920 921 922 923 924
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
925 926
 */
function filter_xss_admin($string) {
927
  return Xss::filterAdmin($string);
928 929 930
}

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

/**
962
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
963
 *
964
 * @param string $string
965
 *   The string with the attribute value.
966
 *
967
 * @return string
968
 *   Cleaned up and HTML-escaped version of $string.
969 970
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
971
 */
972 973
function filter_xss_bad_protocol($string) {
  return UrlValidator::filterBadProtocol($string);
974 975 976 977 978 979
}

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

Dries's avatar
 
Dries committed
980
/**
Dries's avatar
 
Dries committed
981
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
982
 * @{
Dries's avatar
 
Dries committed
983
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
984 985
 */

Dries's avatar
 
Dries committed
986 987 988 989 990
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
991
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
992
  $langcode = $langcode ? $langcode : language(Language::TYPE_CONTENT)->langcode;
Dries's avatar
 
Dries committed
993

Dries's avatar
Dries committed
994
  $output = "<channel>\n";
995 996
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
997 998 999 1000

  // 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;).
1001 1002
  $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . check_plain($langcode) . "</language>\n";
1003
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
1004 1005 1006 1007 1008 1009
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
1010
/**
1011
 * Formats a single RSS item.
Dries's avatar
 
Dries committed
1012 1013 1014
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
1015
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
1016
  $output = "<item>\n";
1017 1018 1019
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
  $output .= ' <description>' . check_plain($description) . "</description>\n";
1020 1021 1022 1023 1024 1025 1026
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
1027
 * Formats XML elements.
1028 1029
 *
 * @param $array
1030
 *   An array where each item represents an element and is either a:
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
 *   - (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) {
1041
  $output = '';
1042 1043
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
1044
      if ($value['key']) {
1045
        $output .= ' <' . $value['key'];
1046
        if (isset($value['attributes']) && is_array($value['attributes'])) {
1047
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
1048 1049
        }

1050
        if (isset($value['value']) && $value['value'] != '') {
1051
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
1052 1053 1054 1055 1056 1057 1058
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
1059
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
1060
    }
Dries's avatar
 
Dries committed
1061
  }
Dries's avatar
 
Dries committed
1062 1063 1064
  return $output;
}

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

1119
  if ($count == 1) {
1120
    return $translated_array[0];
1121
  }
Dries's avatar
 
Dries committed
1122

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