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 aggregation group for system CSS files added to the page.
72
 */
73
const CSS_AGGREGATE_SYSTEM = -100;
74 75

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

/**
81
 * The default aggregation group for theme CSS files added to the page.
82
 */
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
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;
109

110 111 112 113 114
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

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

/**
121
 * The default group for module JavaScript code added to the page.
122
 */
123
const JS_DEFAULT = 0;
124 125

/**
126
 * The default group for theme JavaScript code added to the page.
127
 */
128
const JS_THEME = 100;
129

130
/**
131 132 133
 * Error code indicating that the request exceeded the specified timeout.
 *
 * @see drupal_http_request()
134
 */
135
const HTTP_REQUEST_TIMEOUT = -1;
136

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

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

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

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

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

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

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

205 206 207 208
/**
 * @} End of "defgroup block_caching".
 */

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

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

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

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

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

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

  return $profile;
}


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

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

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

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

  return $breadcrumb;
}

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

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

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

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

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

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

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

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

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

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

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

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

  return $params;
}

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

502
/**
503
 * Parses an array into a valid, rawurlencoded query string.
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
 *
 * 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));
525

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

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

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

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

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

/**
581
 * Parses a system URL string into an associative array suitable for url().
582 583
 *
 * This function should only be used for URLs that have been generated by the
584 585
 * system, such as via url(). It should not be used for URLs that come from
 * external sources, or URLs that link to external resources.
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 635 636 637 638
 *
 * 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 {
639 640 641 642 643
    // 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);
644 645 646 647 648 649 650 651 652 653 654 655
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }

  return $options;
}

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

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

727 728 729 730
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

732
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
733

734
  header('Location: ' . $url, TRUE, $http_response_code);
735 736

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

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

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

Dries's avatar
 
Dries committed
766
/**
767
 * Performs an HTTP request.
Dries's avatar
 
Dries committed
768
 *
769 770
 * 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
771 772 773
 *
 * @param $url
 *   A string containing a fully qualified URI.
774 775 776 777 778 779 780 781 782 783 784 785
 * @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().
786
 *
787 788 789 790 791 792 793 794 795 796
 * @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.
797 798
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
799 800 801 802 803
 *   - 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
804
 */
805
function drupal_http_request($url, array $options = array()) {
806
  $result = new stdClass();
Dries's avatar
 
Dries committed
807

808 809 810 811
  // Parse the URL and make sure we can handle the schema.
  $uri = @parse_url($url);

  if ($uri == FALSE) {
812
    $result->error = 'unable to parse URL';
813
    $result->code = -1001;
814 815 816
    return $result;
  }

817 818 819 820 821
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
    $result->code = -1002;
    return $result;
  }
822

823 824 825 826 827 828 829 830
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
831 832
    'timeout' => 30.0,
    'context' => NULL,
833
  );
834 835 836 837 838 839

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

840 841
  // stream_socket_client() requires timeout to be a float.
  $options['timeout'] = (float) $options['timeout'];
842

843
  // Use a proxy if one is defined and the host is not on the excluded list.
844
  $proxy_server = settings()->get('proxy_server', '');
845 846 847 848 849 850 851 852 853
  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.
854 855
    if ($proxy_username = settings()->get('proxy_username', '')) {
      $proxy_password = settings()->get('proxy_password', '');
856 857 858 859
      $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.
860
    $proxy_user_agent = settings()->get('proxy_user_agent', '');
861 862 863 864 865 866 867 868 869
    // 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
870
  switch ($uri['scheme']) {
871 872
    case 'proxy':
      // Make the socket connection to a proxy server.
873
      $socket = 'tcp://' . $proxy_server . ':' . settings()->get('proxy_port', 8080);
874 875 876 877 878
      // 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
879
    case 'http':
880
    case 'feed':
Dries's avatar
Dries committed
881
      $port = isset($uri['port']) ? $uri['port'] : 80;
882 883 884 885 886
      $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
887
      break;
888

Dries's avatar
 
Dries committed
889
    case 'https':
890
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
891
      $port = isset($uri['port']) ? $uri['port'] : 443;
892 893
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
Dries's avatar
 
Dries committed
894
      break;
895

Dries's avatar
 
Dries committed
896
    default:
897
      $result->error = 'invalid schema ' . $uri['scheme'];
898
      $result->code = -1003;
Dries's avatar
 
Dries committed
899 900 901
      return $result;
  }

902 903 904 905 906 907 908 909
  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
910
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
911
  if (!$fp) {
912 913
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
914
    $result->code = -$errno;
915
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
Dries's avatar
 
Dries committed
916 917 918
    return $result;
  }

Dries's avatar
 
Dries committed
919
  // Construct the path to act on.
Dries's avatar
Dries committed
920 921
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
922
    $path .= '?' . $uri['query'];
Dries's avatar
 
Dries committed
923 924
  }

925 926 927 928
  // 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.
929 930 931
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
932 933 934
  }

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

939 940 941 942 943 944
  // 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.
945 946 947
  $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']);
948 949
  }

950
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
951
  foreach ($options['headers'] as $name => $value) {
952
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
 
Dries committed
953
  }
954
  $request .= "\r\n" . $options['data'];
Dries's avatar
 
Dries committed
955
  $result->request = $request;
956 957 958 959 960 961
  // 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
962

963 964 965 966 967
  // 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'];
968
  $response = '';
969 970

  while ($alive) {
971 972 973
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
974 975
      $info['timed_out'] = TRUE;
      break;
976 977
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
978 979 980 981
    $chunk = fread($fp, 1024);
    $response .= $chunk;
    $info = stream_get_meta_data($fp);
    $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
Dries's avatar
 
Dries committed
982 983 984
  }
  fclose($fp);

985 986 987 988 989
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
990
  // Parse response headers from the response body.
991 992 993
  // 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);
994
  $response = preg_split("/\r\n|\n|\r/", $response);
995

996
  // Parse the response status line.
997 998 999 1000
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

Dries's avatar
 
Dries committed
1001 1002
  $result->headers = array();

1003 1004
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
1005 1006 1007
    list($name, $value) = explode(':', $line, 2);
    $name = strtolower($name);
    if (isset($result->headers[$name]) && $name == 'set-cookie') {
1008 1009
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
1010
      $result->headers[$name] .= ',' . trim($value);
1011 1012
    }
    else {
1013
      $result->headers[$name] = trim($value);
1014
    }
Dries's avatar
 
Dries committed
1015 1016 1017
  }

  $responses = array(
1018 1019 1020 1021 1022