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

Dries's avatar
 
Dries committed
24 25 26 27 28 29 30 31
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
/**
 * @defgroup php_wrappers PHP wrapper functions
 * @{
 * Functions that are wrappers or custom implementations of PHP functions.
 *
 * Certain PHP functions should not be used in Drupal. Instead, Drupal's
 * replacement functions should be used.
 *
 * For example, for improved or more secure UTF8-handling, or RFC-compliant
 * handling of URLs in Drupal.
 *
 * For ease of use and memorizing, all these wrapper functions use the same name
 * as the original PHP function, but prefixed with "drupal_". Beware, however,
 * that not all wrapper functions support the same arguments as the original
 * functions.
 *
 * You should always use these wrapper functions in your code.
 *
 * Wrong:
 * @code
 *   $my_substring = substr($original_string, 0, 5);
 * @endcode
 *
 * Correct:
 * @code
 *   $my_substring = drupal_substr($original_string, 0, 5);
 * @endcode
 *
60
 * @}
61 62
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

257
/**
258
 * Gets the name of the currently active installation profile.
259 260 261 262
 *
 * When this function is called during Drupal's initial installation process,
 * the name of the profile that's about to be installed is stored in the global
 * installation state. At all other times, the standard Drupal systems variable
263 264
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
265 266
 *
 * @return $profile
267
 *   The name of the installation profile.
268 269 270 271 272 273 274 275
 */
function drupal_get_profile() {
  global $install_state;

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

  return $profile;
}


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

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

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

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

  return $breadcrumb;
}

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

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

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

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

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

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

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

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

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

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

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

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

  return $params;
}

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

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

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

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

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

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

  return $options;
}

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

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

695 696 697 698
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

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

  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();
709 710

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

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

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

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

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

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

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

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

843 844 845 846
/**
 * @} End of "defgroup validation".
 */

847 848 849 850
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
851 852 853
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
854 855
 */

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

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

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

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

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

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

Dries's avatar
 
Dries committed
976
/**
Dries's avatar
 
Dries committed
977
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
978
 * @{
Dries's avatar
 
Dries committed
979
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
980 981
 */

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

Dries's avatar
Dries committed
990
  $output = "<channel>\n";
991 992
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
993 994 995 996

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

  return $output;
}

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

  return $output;
}

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

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

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

1115
  if ($count == 1) {
1116
    return $translated_array[0];
1117
  }
Dries's avatar
 
Dries committed
1118

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

1140
/**
1141
 * Parses a given byte count.
1142 1143
 *
 * @param $size