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

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

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

22 23 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
/**
 * @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
 *
50
 * @}
51 52
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

178 179 180 181
/**
 * @} End of "defgroup block_caching".
 */

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

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

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

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

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

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

  return $profile;
}


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

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

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

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

  return $breadcrumb;
}

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

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

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

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

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

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

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

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

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

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

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

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

  return $params;
}

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

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

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

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

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

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

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

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

  return $options;
}

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

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

700 701 702 703
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

705
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
706

707
  header('Location: ' . $url, TRUE, $http_response_code);
708 709

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

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

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

Dries's avatar
 
Dries committed
739
/**
740
 * Performs an HTTP request.
Dries's avatar
 
Dries committed
741
 *
742 743
 * 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
744 745 746
 *
 * @param $url
 *   A string containing a fully qualified URI.
747 748 749 750 751 752 753 754 755 756 757 758
 * @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().
759
 *
760 761 762 763 764 765 766 767 768 769
 * @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.
770 771
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
772 773 774 775 776
 *   - 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
777
 */
778
function drupal_http_request($url, array $options = array()) {
779
  $result = new stdClass();
Dries's avatar
 
Dries committed
780

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

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

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

796 797 798 799 800 801 802 803
  timer_start(__FUNCTION__);

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

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

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

816
  // Use a proxy if one is defined and the host is not on the excluded list.
817
  $proxy_server = settings()->get('proxy_server', '');
818 819 820 821 822 823 824 825 826
  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.
827 828
    if ($proxy_username = settings()->get('proxy_username', '')) {
      $proxy_password = settings()->get('proxy_password', '');
829 830 831 832
      $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.
833
    $proxy_user_agent = settings()->get('proxy_user_agent', '');
834 835 836 837 838 839 840 841 842
    // 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
843
  switch ($uri['scheme']) {
844 845
    case 'proxy':
      // Make the socket connection to a proxy server.
846
      $socket = 'tcp://' . $proxy_server . ':' . settings()->get('proxy_port', 8080);
847 848 849 850 851
      // 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
852
    case 'http':
853
    case 'feed':
Dries's avatar
Dries committed
854
      $port = isset($uri['port']) ? $uri['port'] : 80;
855 856 857 858 859
      $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
860
      break;
861

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

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

875 876 877 878 879 880 881 882
  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
883
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
884
  if (!$fp) {
885 886
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
887
    $result->code = -$errno;
888
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
Dries's avatar
 
Dries committed
889 890 891
    return $result;
  }

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

898 899 900 901
  // 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.
902 903 904
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
905 906 907
  }

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

912 913 914 915 916 917
  // 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.
918 919 920
  $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']);
921 922
  }

923
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
924
  foreach ($options['headers'] as $name => $value) {
925
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
 
Dries committed
926
  }
927
  $request .= "\r\n" . $options['data'];
Dries's avatar
 
Dries committed
928
  $result->request = $request;
929 930 931 932 933 934
  // 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
935

936 937 938 939 940
  // 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'];
941
  $response = '';
942 943

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

958 959 960 961 962
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
963
  // Parse response headers from the response body.
964 965 966
  // 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);
967
  $response = preg_split("/\r\n|\n|\r/", $response);
968

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

Dries's avatar
 
Dries committed
974 975
  $result->headers = array();

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

  $responses = array(
991 992 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
    100 => 'Continue',
    101 => 'Switching Protocols',
    200 => 'OK',
    201 => 'Created',
    202 => 'Accepted',
    203 => 'Non-Authoritative Information',
    204 => 'No Content',
    205 => 'Reset Content',
    206 => 'Partial Content',
    300 => 'Multiple Choices',
    301 => 'Moved Permanently',
    302 => 'Found',
    303 => 'See Other',
    304 => 'Not Modified',
    305 => 'Use Proxy',
    307 => 'Temporary Redirect',
    400 => 'Bad Request',
    401 => 'Unauthorized',
    402 => 'Payment Required',
    403 => 'Forbidden',
    404 => 'Not Found',
    405 => 'Method Not Allowed',
    406 => 'Not Acceptable',
    407 => 'Proxy Authentication Required',
    408 => 'Request Time-out',
    409 => 'Conflict',
    410 => 'Gone',
    411 => 'Length Required',
    412 => 'Precondition Failed',
    413 => 'Request Entity Too Large',
    414 => 'Request-URI Too Large',
    415 => 'Unsupported Media Type',
    416 => 'Requested range not satisfiable',
    417 => 'Expectation Failed',
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Time-out',
    505 => 'HTTP Version not supported',
Dries's avatar
 
Dries committed
1031
  );
1032 1033
  // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  // base code in their class.
Dries's avatar
 
Dries committed
1034 1035 1036
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
1037
  $result->code = $code;
Dries's avatar
 
Dries committed
1038 1039 1040 1041 1042 1043 1044 1045

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
1046
      $location = $result->headers['location'];
1047 1048 1049 1050 1051 1052
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
      elseif ($options['max_redirects']) {
1053 1054 1055
        // Redirect to the new location.
        $options['max_redirects']--;
        $result = drupal_http_request($location, $options);
1056
        $result->redirect_code = $code;
Dries's avatar
 
Dries committed
1057
      }
1058 1059 1060
      if (!isset($result->redirect_url)) {
        $result->redirect_url = $location;
      }
Dries's avatar
 
Dries committed
1061 1062
      break;
    default:
1063
      $result->error = $status_message;
Dries's avatar
 
Dries committed
1064 1065 1066 1067
  }

  return $result;
}
1068 1069 1070 1071 1072 1073 1074 1075

/**
 * 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) {
1076
  $proxy_exceptions = settings()->get('proxy_exceptions', array('localhost', '127.0.0.1'));
1077 1078 1079
  return !in_array(strtolower($host), $proxy_exceptions, TRUE);
}

Dries's avatar
 
Dries committed
1080
/**
1081
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
1082
 */
Dries's avatar
 
Dries committed
1083

Kjartan's avatar
Kjartan committed
1084
/**
Dries's avatar
 
Dries committed
1085
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
1086
 * @{
Dries's avatar
 
Dries committed
1087
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
1088 1089
 */

1090
/**
1091
 * Verifies the syntax of the given e-mail address.
Dries's avatar
 
Dries committed
1092
 *
1093 1094
 * This uses the
 * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
1095
 *
Dries's avatar
 
Dries committed
1096
 * @param $mail
1097
 *   A string containing an e-mail address.
1098
 *
Dries's avatar
 
Dries committed
1099
 * @return
Dries's avatar
 
Dries committed
1100
 *   TRUE if the address is in a valid format.
1101
 */
Dries's avatar
 
Dries committed
1102
function valid_email_address($mail) {
1103
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
1104 1105
}

Dries's avatar
 
Dries committed
1106
/**
1107
 * Verifies the syntax of the given URL.
Dries's avatar
 
Dries committed
1108
 *
1109 1110
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
1111
 * Valid values per RFC 3986.
Dries's avatar
 
Dries committed
1112
 * @param $url
Dries's avatar
 
Dries committed
1113
 *   The URL to verify.
Dries's avatar
 
Dries committed
1114
 * @param $absolute
Dries's avatar
 
Dries committed
1115
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
1116
 *
Dries's avatar
 
Dries committed
1117
 * @return
Dries's avatar
 
Dries committed
1118
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
1119
 */
Dries's avatar
 
Dries committed
1120
function valid_url($url, $absolute = FALSE) {
1121
  if ($absolute) {
1122
    return (bool)preg_match("
1123
      /^                                                      # Start at the beginning of the text
1124
      (?:ftp|https?|feed):\/\/                                # Look for ftp, http, https or feed schemes
1125 1126 1127
      (?:                                                     # Userinfo (optional) which is typically