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

3
use Drupal\Core\Cache\Cache;
4
use Symfony\Component\DependencyInjection\Container;
5
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
6
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
7
use Symfony\Component\Yaml\Parser;
8
use Drupal\Component\PhpStorage\PhpStorageFactory;
9
use Drupal\Component\Utility\NestedArray;
10
use Drupal\Core\Cache\CacheBackendInterface;
11
use Drupal\Core\Datetime\DrupalDateTime;
12
use Drupal\Core\Database\Database;
13
use Drupal\Core\SystemListingInfo;
14
use Drupal\Core\Template\Attribute;
15

Dries's avatar
 
Dries committed
16 17 18 19 20 21 22 23
/**
 * @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.
 */

24 25 26 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
/**
 * @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
 *
52
 * @}
53 54
 */

55 56 57
/**
 * Return status for saving which involved creating a new item.
 */
58
const SAVED_NEW = 1;
59 60 61 62

/**
 * Return status for saving which involved an update to an existing item.
 */
63
const SAVED_UPDATED = 2;
64 65 66 67

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

70
/**
71
 * The default group for system CSS files added to the page.
72
 */
73
const CSS_SYSTEM = -100;
74 75

/**
76
 * The default group for module CSS files added to the page.
77
 */
78
const CSS_DEFAULT = 0;
79 80

/**
81
 * The default group for theme CSS files added to the page.
82
 */
83
const CSS_THEME = 100;
84

85 86 87 88 89
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

90
/**
91
 * The default group for JavaScript and jQuery libraries added to the page.
92
 */
93
const JS_LIBRARY = -100;
94 95

/**
96
 * The default group for module JavaScript code added to the page.
97
 */
98
const JS_DEFAULT = 0;
99 100

/**
101
 * The default group for theme JavaScript code added to the page.
102
 */
103
const JS_THEME = 100;
104

105
/**
106 107 108
 * Error code indicating that the request exceeded the specified timeout.
 *
 * @see drupal_http_request()
109
 */
110
const HTTP_REQUEST_TIMEOUT = -1;
111

112
/**
113 114 115
 * @defgroup block_caching Block Caching
 * @{
 * Constants that define each block's caching state.
116
 *
117 118 119 120 121 122 123 124 125 126
 * 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.
127
 *
128 129
 * The block cache is cleared when the 'content' cache tag is invalidated,
 * following the same pattern as the page cache (node, comment, user, taxonomy
130
 * added or updated...).
131 132 133 134 135
 *
 * Note that user 1 is excluded from block caching.
 */

/**
136 137 138 139 140 141 142
 * 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.
143
 */
144
const DRUPAL_NO_CACHE = -1;
145 146

/**
147 148
 * The block is handling its own caching in its hook_block_view().
 *
149 150
 * This setting is useful when time based expiration is needed or a site uses a
 * node access which invalidates standard block cache.
151
 */
152
const DRUPAL_CACHE_CUSTOM = -2;
153 154

/**
155 156 157 158
 * 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.
159
 */
160
const DRUPAL_CACHE_PER_ROLE = 0x0001;
161 162

/**
163 164
 * The block or element can change depending on the user.
 *
165 166 167
 * 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.
 */
168
const DRUPAL_CACHE_PER_USER = 0x0002;
169 170 171 172

/**
 * The block or element can change depending on the page being viewed.
 */
173
const DRUPAL_CACHE_PER_PAGE = 0x0004;
174 175

/**
176
 * The block or element is the same for every user and page that it is visible.
177
 */
178
const DRUPAL_CACHE_GLOBAL = 0x0008;
179

180 181 182 183
/**
 * @} End of "defgroup block_caching".
 */

184 185 186 187 188 189 190 191 192
/**
 * 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";

193
/**
194
 * Adds content to a specified region.
195 196
 *
 * @param $region
197
 *   Page region the content is added to.
198
 * @param $data
199
 *   Content to be added.
200
 */
201
function drupal_add_region_content($region = NULL, $data = NULL) {
202 203
  static $content = array();

204
  if (isset($region) && isset($data)) {
205 206 207 208 209 210
    $content[$region][] = $data;
  }
  return $content;
}

/**
211
 * Gets assigned content for a given region.
212 213
 *
 * @param $region
214 215
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
216
 * @param $delimiter
217
 *   Content to be inserted between imploded array elements.
218
 */
219 220
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
221 222
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
223
      return implode($delimiter, $content[$region]);
224
    }
225 226 227 228
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
229
        $content[$region] = implode($delimiter, $content[$region]);
230 231 232 233 234 235
      }
    }
    return $content;
  }
}

236
/**
237
 * Gets the name of the currently active installation profile.
238 239 240 241
 *
 * 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
242 243
 * table contains the name of the current profile, and we can call
 * variable_get() to determine what one is active.
244 245
 *
 * @return $profile
246
 *   The name of the installation profile.
247 248 249 250 251 252 253 254
 */
function drupal_get_profile() {
  global $install_state;

  if (isset($install_state['parameters']['profile'])) {
    $profile = $install_state['parameters']['profile'];
  }
  else {
255
    $profile = variable_get('install_profile', 'standard');
256 257 258 259 260 261
  }

  return $profile;
}


Dries's avatar
 
Dries committed
262
/**
263
 * Sets the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
264
 *
Dries's avatar
 
Dries committed
265 266 267
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
268
 */
Dries's avatar
 
Dries committed
269
function drupal_set_breadcrumb($breadcrumb = NULL) {
270
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries's avatar
 
Dries committed
271

272
  if (isset($breadcrumb)) {
Dries's avatar
 
Dries committed
273 274 275 276 277
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
 
Dries committed
278
/**
279
 * Gets the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
280
 */
Dries's avatar
 
Dries committed
281 282 283
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

284
  if (!isset($breadcrumb)) {
Dries's avatar
 
Dries committed
285 286 287 288 289 290
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
291
/**
292
 * Adds output to the HEAD tag of the HTML page.
293
 *
294
 * This function can be called as long as the headers aren't sent. Pass no
295 296 297 298 299 300 301 302 303 304 305 306 307
 * 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
308
 */
309 310
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
311

312 313 314 315 316 317 318 319 320 321
  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
322 323 324 325
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
326
/**
327 328 329 330 331 332 333 334 335 336
 * 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(
337
      'charset' => 'utf-8',
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
    ),
    // 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;
}

/**
359
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
Dries's avatar
 
Dries committed
360
 */
Dries's avatar
Dries committed
361
function drupal_get_html_head() {
362 363 364
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
365 366
}

367
/**
368
 * Adds a feed URL for the current page.
369
 *
370 371
 * This function can be called as long the HTML header hasn't been sent.
 *
372
 * @param $url
373
 *   An internal system path or a fully qualified external URL of the feed.
374
 * @param $title
375
 *   The title of the feed.
376
 */
377
function drupal_add_feed($url = NULL, $title = '') {
378
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
379

380
  if (isset($url)) {
381
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
382

383 384 385 386 387 388 389 390
    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)),
    ));
391 392 393 394 395
  }
  return $stored_feed_links;
}

/**
396
 * Gets the feed URLs for the current page.
397 398
 *
 * @param $delimiter
399
 *   A delimiter to split feeds by.
400 401 402 403 404 405
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
 
Dries committed
406
/**
407
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
408
 * @{
Dries's avatar
 
Dries committed
409
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
410 411
 */

412
/**
413
 * Processes a URL query parameter array to remove unwanted elements.
414 415
 *
 * @param $query
416
 *   (optional) An array to be processed. Defaults to $_GET.
417
 * @param $exclude
418
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
419
 *   exclude nested items.
420
 * @param $parent
421 422
 *   Internal use only. Used to build the $query array key for nested items.
 *
423
 * @return
424
 *   An array containing query parameters, which can be used for url().
425
 */
426
function drupal_get_query_parameters(array $query = NULL, array $exclude = array(), $parent = '') {
427 428 429 430 431 432 433 434 435 436 437
  // 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);
  }
438

439
  $params = array();
440
  foreach ($query as $key => $value) {
441 442 443
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
444 445
    }

446 447 448 449 450
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
451
    }
452 453 454 455 456
  }

  return $params;
}

457
/**
458
 * Splits a URL-encoded query string into an array.
459 460 461 462 463
 *
 * @param $query
 *   The query string to split.
 *
 * @return
464
 *   An array of URL decoded couples $param_name => $value.
465 466 467 468 469 470
 */
function drupal_get_query_array($query) {
  $result = array();
  if (!empty($query)) {
    foreach (explode('&', $query) as $param) {
      $param = explode('=', $param);
471
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
472 473 474 475 476
    }
  }
  return $result;
}

477
/**
478
 * Parses an array into a valid, rawurlencoded query string.
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
 *
 * 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));
500

501
    // Recurse into children.
502
    if (is_array($value)) {
503 504 505 506 507
      $params[] = drupal_http_build_query($value, $key);
    }
    // If a query parameter value is NULL, only append its key.
    elseif (!isset($value)) {
      $params[] = $key;
508 509
    }
    else {
510 511
      // For better readability of paths in query strings, we decode slashes.
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
512 513 514 515 516 517
    }
  }

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

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

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

541
  if (isset($_GET['destination'])) {
542
    $destination = array('destination' => $_GET['destination']);
543 544
  }
  else {
545
    $path = current_path();
546
    $query = drupal_http_build_query(drupal_get_query_parameters());
547
    if ($query != '') {
548
      $path .= '?' . $query;
549
    }
550 551 552 553 554 555
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
556
 * Parses a system URL string into an associative array suitable for url().
557 558
 *
 * This function should only be used for URLs that have been generated by the
559 560
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
 *
 * 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 {
614 615 616 617 618
    // 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);
619 620 621 622 623 624 625 626 627 628 629 630
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

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

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

702 703 704 705
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

707
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
708

709
  header('Location: ' . $url, TRUE, $http_response_code);
710 711

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

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

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

Dries's avatar
 
Dries committed
741
/**
742
 * Performs an HTTP request.
Dries's avatar
 
Dries committed
743
 *
744 745
 * This is a flexible and powerful HTTP client implementation. Correctly
 * handles GET, POST, PUT or any other HTTP requests. Handles redirects.
Dries's avatar
 
Dries committed
746 747 748
 *
 * @param $url
 *   A string containing a fully qualified URI.
749 750 751 752 753 754 755 756 757 758 759 760
 * @param array $options
 *   (optional) An array that can have one or more of the following elements:
 *   - headers: An array containing request headers to send as name/value pairs.
 *   - method: A string containing the request method. Defaults to 'GET'.
 *   - data: A string containing the request body, formatted as
 *     'param=value&param=value&...'. Defaults to NULL.
 *   - max_redirects: An integer representing how many times a redirect
 *     may be followed. Defaults to 3.
 *   - timeout: A float representing the maximum number of seconds the function
 *     call may take. The default is 30 seconds. If a timeout occurs, the error
 *     code is set to the HTTP_REQUEST_TIMEOUT constant.
 *   - context: A context resource created with stream_context_create().
761
 *
762 763 764 765 766 767 768 769 770 771
 * @return object
 *   An object that can have one or more of the following components:
 *   - request: A string containing the request body that was sent.
 *   - code: An integer containing the response status code, or the error code
 *     if an error occurred.
 *   - protocol: The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
 *   - status_message: The status message from the response, if a response was
 *     received.
 *   - redirect_code: If redirected, an integer containing the initial response
 *     status code.
772 773
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
774 775 776 777 778
 *   - error: If an error occurred, the error message. Otherwise not set.
 *   - headers: An array containing the response headers as name/value pairs.
 *     HTTP header names are case-insensitive (RFC 2616, section 4.2), so for
 *     easy access the array keys are returned in lower case.
 *   - data: A string containing the response body that was received.
Dries's avatar
 
Dries committed
779
 */
780
function drupal_http_request($url, array $options = array()) {
781
  $result = new stdClass();
Dries's avatar
 
Dries committed
782

783 784 785 786
  // Parse the URL and make sure we can handle the schema.
  $uri = @parse_url($url);

  if ($uri == FALSE) {
787
    $result->error = 'unable to parse URL';
788
    $result->code = -1001;
789 790 791
    return $result;
  }

792 793 794 795 796
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
    $result->code = -1002;
    return $result;
  }
797

798 799 800 801 802 803 804 805
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
806 807
    'timeout' => 30.0,
    'context' => NULL,
808
  );
809 810 811 812 813 814

  // Merge the default headers.
  $options['headers'] += array(
    'User-Agent' => 'Drupal (+http://drupal.org/)',
  );

815 816
  // stream_socket_client() requires timeout to be a float.
  $options['timeout'] = (float) $options['timeout'];
817

818
  // Use a proxy if one is defined and the host is not on the excluded list.
819
  $proxy_server = settings()->get('proxy_server', '');
820 821 822 823 824 825 826 827 828
  if ($proxy_server && _drupal_http_use_proxy($uri['host'])) {
    // Set the scheme so we open a socket to the proxy server.
    $uri['scheme'] = 'proxy';
    // Set the path to be the full URL.
    $uri['path'] = $url;
    // Since the URL is passed as the path, we won't use the parsed query.
    unset($uri['query']);

    // Add in username and password to Proxy-Authorization header if needed.
829 830
    if ($proxy_username = settings()->get('proxy_username', '')) {
      $proxy_password = settings()->get('proxy_password', '');
831 832 833 834
      $options['headers']['Proxy-Authorization'] = 'Basic ' . base64_encode($proxy_username . (!empty($proxy_password) ? ":" . $proxy_password : ''));
    }
    // Some proxies reject requests with any User-Agent headers, while others
    // require a specific one.
835
    $proxy_user_agent = settings()->get('proxy_user_agent', '');
836 837 838 839 840 841 842 843 844
    // The default value matches neither condition.
    if ($proxy_user_agent === NULL) {
      unset($options['headers']['User-Agent']);
    }
    elseif ($proxy_user_agent) {
      $options['headers']['User-Agent'] = $proxy_user_agent;
    }
  }

Dries's avatar
 
Dries committed
845
  switch ($uri['scheme']) {
846 847
    case 'proxy':
      // Make the socket connection to a proxy server.
848
      $socket = 'tcp://' . $proxy_server . ':' . settings()->get('proxy_port', 8080);
849 850 851 852 853
      // The Host header still needs to match the real request.
      $options['headers']['Host'] = $uri['host'];
      $options['headers']['Host'] .= isset($uri['port']) && $uri['port'] != 80 ? ':' . $uri['port'] : '';
      break;

Dries's avatar
 
Dries committed
854
    case 'http':
855
    case 'feed':
Dries's avatar
Dries committed
856
      $port = isset($uri['port']) ? $uri['port'] : 80;
857 858 859 860 861
      $socket = 'tcp://' . $uri['host'] . ':' . $port;
      // RFC 2616: "non-standard ports MUST, default ports MAY be included".
      // We don't add the standard port to prevent from breaking rewrite rules
      // checking the host that do not take into account the port number.
      $options['headers']['Host'] = $uri['host'] . ($port != 80 ? ':' . $port : '');
Dries's avatar
 
Dries committed
862
      break;
863

Dries's avatar
 
Dries committed
864
    case 'https':
865
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
866
      $port = isset($uri['port']) ? $uri['port'] : 443;
867 868
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
Dries's avatar
 
Dries committed
869
      break;
870

Dries's avatar
 
Dries committed
871
    default:
872
      $result->error = 'invalid schema ' . $uri['scheme'];
873
      $result->code = -1003;
Dries's avatar
 
Dries committed
874 875 876
      return $result;
  }

877 878 879 880 881 882 883 884
  if (empty($options['context'])) {
    $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout']);
  }
  else {
    // Create a stream with context. Allows verification of a SSL certificate.
    $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout'], STREAM_CLIENT_CONNECT, $options['context']);
  }

Dries's avatar
 
Dries committed
885
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
886
  if (!$fp) {
887 888
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
889
    $result->code = -$errno;
890
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
Dries's avatar
 
Dries committed
891 892 893
    return $result;
  }

Dries's avatar
 
Dries committed
894
  // Construct the path to act on.
Dries's avatar
Dries committed
895 896
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
897
    $path .= '?' . $uri['query'];
Dries's avatar
 
Dries committed
898 899
  }

900 901 902 903
  // Only add Content-Length if we actually have any content or if it is a POST
  // or PUT request. Some non-standard servers get confused by Content-Length in
  // at least HEAD/GET requests, and Squid always requires Content-Length in
  // POST/PUT requests.
904 905 906
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
907 908 909
  }

  // If the server URL has a user then attempt to use basic authentication.
910
  if (isset($uri['user'])) {
911
    $options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (isset($uri['pass']) ? ':' . $uri['pass'] : ''));
912 913
  }

914 915 916 917 918 919
  // If the database prefix is being used by SimpleTest to run the tests in a copied
  // database then set the user-agent header to the database prefix so that any
  // calls to other Drupal pages will run the SimpleTest prefixed database. The
  // user-agent is used to ensure that multiple testing sessions running at the
  // same time won't interfere with each other as they would if the database
  // prefix were stored statically in a file or database variable.
920 921 922
  $test_info = &$GLOBALS['drupal_test_info'];
  if (!empty($test_info['test_run_id'])) {
    $options['headers']['User-Agent'] = drupal_generate_test_ua($test_info['test_run_id']);
923 924
  }

925
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
926
  foreach ($options['headers'] as $name => $value) {
927
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
 
Dries committed
928
  }
929
  $request .= "\r\n" . $options['data'];
Dries's avatar
 
Dries committed
930
  $result->request = $request;
931 932 933 934 935 936
  // Calculate how much time is left of the original timeout value.
  $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
  if ($timeout > 0) {
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
    fwrite($fp, $request);
  }
Dries's avatar
 
Dries committed
937

938 939 940 941 942
  // Fetch response. Due to PHP bugs like http://bugs.php.net/bug.php?id=43782
  // and http://bugs.php.net/bug.php?id=46049 we can't rely on feof(), but
  // instead must invoke stream_get_meta_data() each iteration.
  $info = stream_get_meta_data($fp);
  $alive = !$info['eof'] && !$info['timed_out'];
943
  $response = '';
944 945

  while ($alive) {
946 947 948
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
949 950
      $info['timed_out'] = TRUE;
      break;
951 952
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
953 954 955 956
    $chunk = fread($fp, 1024);
    $response .= $chunk;
    $info = stream_get_meta_data($fp);
    $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
Dries's avatar
 
Dries committed
957 958 959
  }
  fclose($fp);

960 961 962 963 964
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
965
  // Parse response headers from the response body.
966 967 968
  // Be tolerant of malformed HTTP responses that separate header and body with
  // \n\n or \r\r instead of \r\n\r\n.
  list($response, $result->data) = preg_split("/\r\n\r\n|\n\n|\r\r/", $response, 2);
969
  $response = preg_split("/\r\n|\n|\r/", $response);
970

971
  // Parse the response status line.
972 973 974 975
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

Dries's avatar
 
Dries committed
976 977
  $result->headers = array();

978 979
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
980 981 982
    list($name, $value) = explode(':', $line, 2);
    $name = strtolower($name);
    if (isset($result->headers[$name]) && $name == 'set-cookie') {
983 984
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
985
      $result->headers[$name] .= ',' . trim($value);
986 987
    }
    else {
988
      $result->headers[$name] = trim($value);
989
    }
Dries's avatar
 
Dries committed
990 991 992
  }

  $responses = array(
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
    100 => 'Continue',
    101 => 'Switching Protocols',
    200 => 'OK',
    201