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

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

Dries's avatar
 
Dries committed
19 20 21 22 23 24 25 26
/**
 * @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.
 */

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/**
 * @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
 *
55
 * @}
56 57
 */

58 59 60
/**
 * Return status for saving which involved creating a new item.
 */
61
const SAVED_NEW = 1;
62 63 64 65

/**
 * Return status for saving which involved an update to an existing item.
 */
66
const SAVED_UPDATED = 2;
67 68 69 70

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

73
/**
74
 * The default aggregation group for system CSS files added to the page.
75
 */
76
const CSS_AGGREGATE_SYSTEM = -100;
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 328
 * arguments (or NULL for both) to retrieve the currently stored elements.
 *
 * @param $data
 *   A renderable array. If the '#type' key is not set then 'html_tag' will be
 *   added as the default '#type'.
 * @param $key
 *   A unique string key to allow implementations of hook_html_head_alter() to
 *   identify the element in $data. Required if $data is not NULL.
 *
 * @return
 *   An array of all stored HEAD elements.
 *
 * @see theme_html_tag()
Dries's avatar
Dries committed
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 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
 *
 * This differs from http_build_query() as we need to rawurlencode() (instead of
 * urlencode()) all query parameters.
 *
 * @param $query
 *   The query parameter array to be processed, e.g. $_GET.
 * @param $parent
 *   Internal use only. Used to build the $query array key for nested items.
 *
 * @return
 *   A rawurlencoded string which can be used as or appended to the URL query
 *   string.
 *
 * @see drupal_get_query_parameters()
 * @ingroup php_wrappers
 */
function drupal_http_build_query(array $query, $parent = '') {
  $params = array();

  foreach ($query as $key => $value) {
    $key = ($parent ? $parent . '[' . rawurlencode($key) . ']' : rawurlencode($key));
521

522
    // Recurse into children.
523
    if (is_array($value)) {
524 525 526 527 528
      $params[] = drupal_http_build_query($value, $key);
    }
    // If a query parameter value is NULL, only append its key.
    elseif (!isset($value)) {
      $params[] = $key;
529 530
    }
    else {
531 532
      // For better readability of paths in query strings, we decode slashes.
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
533 534 535 536 537 538
    }
  }

  return implode('&', $params);
}

539
/**
540
 * Prepares a 'destination' URL query parameter for use with drupal_goto().
541
 *
542 543 544 545
 * 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.
546
 *
547 548 549 550 551 552
 * @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()
553 554 555
 * @see drupal_goto()
 */
function drupal_get_destination() {
556 557 558 559 560 561
  $destination = &drupal_static(__FUNCTION__);

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

562
  if (isset($_GET['destination'])) {
563
    $destination = array('destination' => $_GET['destination']);
564 565
  }
  else {
566
    $path = current_path();
567
    $query = drupal_http_build_query(drupal_get_query_parameters());
568
    if ($query != '') {
569
      $path .= '?' . $query;
570
    }
571 572 573 574 575 576
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
577
 * Parses a system URL string into an associative array suitable for url().
578 579
 *
 * This function should only be used for URLs that have been generated by the
580 581
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
 *
 * 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 {
635 636 637 638 639
    // 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);
640 641 642 643 644 645 646 647 648 649 650 651
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

/**
652
 * Encodes a Drupal path for use in a URL.
653
 *
654
 * For aesthetic reasons slashes are not escaped.
655
 *
656 657
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
658 659
 *
 * @param $path
660
 *   The Drupal path to encode.
661 662
 */
function drupal_encode_path($path) {
663
  return str_replace('%2F', '/', rawurlencode($path));
664 665
}

Kjartan's avatar
Kjartan committed
666
/**
667
 * Sends the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
668
 *
Dries's avatar
 
Dries committed
669 670
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
671
 *
672 673 674 675 676 677
 * 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
678 679
 *   $query = array('destination' => "node/$node->nid");
 *   $link = l(t('Log in'), 'user/login', array('query' => $query));
680
 * @endcode
681
 *
682 683
 * 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
684
 *
685 686
 * This function ends the request; use it instead of a return in your menu
 * callback.
Dries's avatar
 
Dries committed
687 688
 *
 * @param $path
689 690
 *   (optional) A Drupal path or a full URL, which will be passed to url() to
 *   compute the redirect for the URL.
691
 * @param $options
692
 *   (optional) An associative array of additional URL options to pass to url().
693
 * @param $http_response_code
694 695
 *   (optional) The HTTP status code to use for the redirection, defaults to
 *   302. The valid values for 3xx redirection status codes are defined in
696 697 698 699 700 701 702 703 704 705
 *   @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.
706
 *
707
 * @see drupal_get_destination()
708
 * @see url()
Kjartan's avatar
Kjartan committed
709
 */
710 711
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
712 713
  // We do not allow absolute URLs to be passed via $_GET, as this can be an
  // attack vector, with the following exception:
714 715
  // - Absolute URLs that point to this site (i.e. same base URL and
  //   base path) are allowed.
716
  if (isset($_GET['destination']) && (!url_is_external($_GET['destination']) || _external_url_is_local($_GET['destination']))) {
717
    $destination = drupal_parse_url($_GET['destination']);
718 719 720
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
721 722
  }

723 724 725 726
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

728
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
729

730
  header('Location: ' . $url, TRUE, $http_response_code);
731 732

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

738 739 740 741 742 743 744 745 746 747
/**
 * 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) {
748 749
  $url_parts = parse_url($url);
  $base_host = parse_url($GLOBALS['base_url'], PHP_URL_HOST);
750

751 752 753 754
  if (!isset($url_parts['path'])) {
    return ($url_parts['host'] == $base_host);
  }
  else {
755 756 757 758
    // 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);
759
  }
760 761
}

762 763 764 765 766 767 768
/**
 * 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) {
769
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
770 771 772
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
 
Dries committed
773
/**
774
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
775
 */
Dries's avatar
 
Dries committed
776

Kjartan's avatar
Kjartan committed
777
/**
Dries's avatar
 
Dries committed
778
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
779
 * @{
Dries's avatar
 
Dries committed
780
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
781 782
 */

783
/**
784
 * Verifies the syntax of the given e-mail address.
Dries's avatar
 
Dries committed
785
 *
786 787
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
788
 *
Dries's avatar
 
Dries committed
789
 * @param $mail
790
 *   A string containing an e-mail address.
791
 *
Dries's avatar
 
Dries committed
792
 * @return
Dries's avatar
 
Dries committed
793
 *   TRUE if the address is in a valid format.
794
 */
Dries's avatar
 
Dries committed
795
function valid_email_address($mail) {
796
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
797 798
}

Dries's avatar
 
Dries committed
799
/**
800
 * Verifies the syntax of the given URL.
Dries's avatar
 
Dries committed
801
 *
802 803
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
804
 * Valid values per RFC 3986.
Dries's avatar
 
Dries committed
805
 * @param $url
Dries's avatar
 
Dries committed
806
 *   The URL to verify.
Dries's avatar
 
Dries committed
807
 * @param $absolute
Dries's avatar
 
Dries committed
808
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
809
 *
Dries's avatar
 
Dries committed
810
 * @return
Dries's avatar
 
Dries committed
811
 *   TRUE if the URL is in a valid format.
812 813
 *
 * @see \Drupal\Component\Utility\UrlValidator::isValid()
Dries's avatar
 
Dries committed
814
 */
Dries's avatar
 
Dries committed
815
function valid_url($url, $absolute = FALSE) {
816
  return UrlValidator::isValid($url, $absolute);
Dries's avatar
 
Dries committed
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 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
/**
 * 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);
}

865 866 867 868
/**
 * @} End of "defgroup validation".
 */

869 870 871 872
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
873 874 875
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
876 877
 */

Dries's avatar
Dries committed
878
/**
879 880 881 882 883 884
 * 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
885 886 887
 * be a plain-text string for passing to t(), l(),
 * Drupal\Core\Template\Attribute, or another function that will call
 * check_plain() separately.
888 889 890 891 892 893 894 895 896 897
 *
 * @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.
 *
898
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
899 900
 */
function drupal_strip_dangerous_protocols($uri) {
901
  return UrlValidator::stripDangerousProtocols($uri);
902 903 904
}

/**
905
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
906 907 908 909 910 911 912
 *
 * @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
913 914 915 916 917
 *   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.
918
 *
919 920
 * @see \Drupal\Component\Utility\Url::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
921 922
 */
function check_url($uri) {
923
  return String::checkPlain(UrlValidator::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
924 925
}

926
/**
927
 * Applies a very permissive XSS/HTML filter for admin-only use.
928 929 930 931 932 933 934
 *
 * 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.
935 936 937 938 939 940 941 942
 *
 * @param string $string
 *   The string to apply the filter to.
 *
 * @return string
 *   The filtered string.
 *
 * @see \Drupal\Component\Utility\Xss::filterAdmin()
943 944
 */
function filter_xss_admin($string) {
945
  return Xss::filterAdmin($string);
946 947 948
}

/**
949
 * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
950
 *
951 952
 * 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.
953 954
 *
 * This code does four things:
955 956 957 958 959
 * - 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:).
960 961
 *
 * @param $string
962 963
 *   The string with raw HTML in it. It will be stripped of everything that can
 *   cause an XSS attack.
964 965
 * @param $allowed_tags
 *   An array of allowed tags.
966 967 968 969 970
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not
 *   valid UTF-8.
 *
971 972
 * @see \Drupal\Component\Utility\Xss::filter()
 *
973
 * @ingroup sanitization
974 975
 */
function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
976
  return Xss::filter($string, $allowed_tags);
977 978 979
}

/**
980
 * Processes an HTML attribute value and strips dangerous protocols from URLs.
981
 *
982
 * @param string $string
983
 *   The string with the attribute value.
984
 *
985
 * @return string
986
 *   Cleaned up and HTML-escaped version of $string.
987 988
 *
 * @see \Drupal\Component\Utility\Url::filterBadProtocol()
989
 */
990 991
function filter_xss_bad_protocol($string) {
  return UrlValidator::filterBadProtocol($string);
992 993 994 995 996 997
}

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

Dries's avatar
 
Dries committed
998
/**
Dries's avatar
 
Dries committed
999
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
1000
 * @{
Dries's avatar
 
Dries committed
1001
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
1002 1003
 */

Dries's avatar
 
Dries committed
1004 1005 1006 1007 1008
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
1009
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
1010
  $langcode = $langcode ? $langcode : language(Language::TYPE_CONTENT)->langcode;
Dries's avatar
 
Dries committed
1011

Dries's avatar
Dries committed
1012
  $output = "<channel>\n";
1013 1014
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
1015 1016 1017 1018

  // 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;).
1019 1020
  $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
  $output .= ' <language>' . check_plain($langcode) . "</language>\n";
1021
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
1022 1023 1024 1025 1026 1027
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
1028
/**
1029
 * Formats a single RSS item.
Dries's avatar
 
Dries committed
1030 1031 1032
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
1033
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
1034
  $output = "<item>\n";
1035 1036 1037
  $output .= ' <title>' . check_plain($title) . "</title>\n";
  $output .= ' <link>' . check_url($link) . "</link>\n";
  $output .= ' <description>' . check_plain($description) . "</description>\n";
1038 1039 1040 1041 1042 1043 1044
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
1045
 * Formats XML elements.
1046 1047
 *
 * @param $array
1048
 *   An array where each item represents an element and is either a:
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
 *   - (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) {
1059
  $output = '';
1060 1061
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
1062
      if ($value['key']) {
1063
        $output .= ' <' . $value['key'];
1064
        if (isset($value['attributes']) && is_array($value['attributes'])) {
1065
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
1066 1067
        }

1068
        if (isset($value['value']) && $value['value'] != '') {
1069
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
1070 1071 1072 1073 1074 1075 1076
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
1077
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
1078
    }
Dries's avatar
 
Dries committed
1079
  }
Dries's avatar
 
Dries committed
1080 1081 1082
  return $output;
}

Dries's avatar
 
Dries committed
1083
/**
1084
 * Formats a string containing a count of items.
Dries's avatar
 
Dries committed
1085
 *
Dries's avatar
 
Dries committed
1086
 * This function ensures that the string is pluralized correctly. Since t() is
1087 1088
 * called by this function, make sure not to pass already-localized strings to
 * it.
Dries's avatar
 
Dries committed
1089
 *
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
 * 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.',
1100
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
1101 1102
 * @endcode
 *
Dries's avatar
 
Dries committed
1103 1104 1105
 * @param $count
 *   The item count to display.
 * @param $singular
1106 1107 1108
 *   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
1109
 * @param $plural
1110 1111 1112
 *   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".
1113
 * @param $args
1114
 *   An associative array of replacements to make after translation. Instances
1115
 *   of any key in this array are replaced with the corresponding value.
1116 1117 1118
 *   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.
1119
 * @param $options
1120 1121
 *   An associative array of additional options. See t() for allowed keys.
 *
Dries's avatar
 
Dries committed
1122 1123
 * @return
 *   A translated string.
1124 1125 1126
 *
 * @see t()
 * @see format_string()
Dries's avatar
 
Dries committed
1127
 */
1128
function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
1129
  $args['@count'] = $count;
1130 1131 1132 1133 1134 1135 1136
  // 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);

1137
  if ($count == 1) {
1138
    return $translated_array[0];
1139
  }
Dries's avatar
 
Dries committed
1140

1141
  // Get the plural index through the gettext formula.
1142
  // @todo implement static variable to minimize function_exists() usage.
1143
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
1144 1145 1146
  if ($index == 0) {
    // Singular form.
    return $translated_array[0];
Dries's avatar
 
Dries committed
1147 1148
  }
  else {
1149 1150 1151 1152 1153 1154 1155 1156 1157
    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
1158 1159