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

3
use Drupal\Component\Utility\NestedArray;
4
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
5
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
6
use Drupal\Core\Cache\CacheBackendInterface;
7
use Drupal\Core\Database\Database;
8
use Drupal\Core\Template\Attribute;
9

Dries's avatar
 
Dries committed
10 11 12 13 14 15 16 17
/**
 * @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.
 */

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
/**
 * @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
 *
46
 * @}
47 48
 */

49 50 51
/**
 * Return status for saving which involved creating a new item.
 */
52
const SAVED_NEW = 1;
53 54 55 56

/**
 * Return status for saving which involved an update to an existing item.
 */
57
const SAVED_UPDATED = 2;
58 59 60 61

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

64
/**
65
 * The default group for system CSS files added to the page.
66
 */
67
const CSS_SYSTEM = -100;
68 69

/**
70
 * The default group for module CSS files added to the page.
71
 */
72
const CSS_DEFAULT = 0;
73 74

/**
75
 * The default group for theme CSS files added to the page.
76
 */
77
const CSS_THEME = 100;
78

79
/**
80
 * The default group for JavaScript and jQuery libraries added to the page.
81
 */
82
const JS_LIBRARY = -100;
83 84

/**
85
 * The default group for module JavaScript code added to the page.
86
 */
87
const JS_DEFAULT = 0;
88 89

/**
90
 * The default group for theme JavaScript code added to the page.
91
 */
92
const JS_THEME = 100;
93

94 95 96
/**
 * The default group for JavaScript settings added to the page.
 */
97
const JS_SETTING = 200;
98

99
/**
100 101 102
 * Error code indicating that the request exceeded the specified timeout.
 *
 * @see drupal_http_request()
103
 */
104
const HTTP_REQUEST_TIMEOUT = -1;
105

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

/**
130 131 132 133 134 135 136
 * 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.
137
 */
138
const DRUPAL_NO_CACHE = -1;
139 140

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

/**
149 150 151 152
 * 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.
153
 */
154
const DRUPAL_CACHE_PER_ROLE = 0x0001;
155 156

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

/**
 * The block or element can change depending on the page being viewed.
 */
167
const DRUPAL_CACHE_PER_PAGE = 0x0004;
168 169

/**
170
 * The block or element is the same for every user and page that it is visible.
171
 */
172
const DRUPAL_CACHE_GLOBAL = 0x0008;
173

174 175 176 177
/**
 * @} End of "defgroup block_caching".
 */

178 179 180 181 182 183 184 185 186
/**
 * 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";

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

198
  if (isset($region) && isset($data)) {
199 200 201 202 203 204
    $content[$region][] = $data;
  }
  return $content;
}

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

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

  if (isset($install_state['parameters']['profile'])) {
    $profile = $install_state['parameters']['profile'];
  }
  else {
249
    $profile = variable_get('install_profile', 'standard');
250 251 252 253 254 255
  }

  return $profile;
}


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

266
  if (isset($breadcrumb)) {
Dries's avatar
 
Dries committed
267 268 269 270 271
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
 
Dries committed
272
/**
273
 * Gets the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
274
 */
Dries's avatar
 
Dries committed
275 276 277
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

278
  if (!isset($breadcrumb)) {
Dries's avatar
 
Dries committed
279 280 281 282 283 284
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

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

306 307 308 309 310 311 312 313 314 315
  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
316 317 318 319
  }
  return $stored_head;
}

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

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

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

374
  if (isset($url)) {
375
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
376

377 378 379 380 381 382 383 384
    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)),
    ));
385 386 387 388 389
  }
  return $stored_feed_links;
}

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

Dries's avatar
 
Dries committed
400
/**
401
 * @defgroup http_handling HTTP handling
Dries's avatar
 
Dries committed
402
 * @{
Dries's avatar
 
Dries committed
403
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
404 405
 */

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

433
  $params = array();
434
  foreach ($query as $key => $value) {
435 436 437
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
438 439
    }

440 441 442 443 444
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
445
    }
446 447 448 449 450
  }

  return $params;
}

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

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

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

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

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

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

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

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

  return $options;
}

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

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

693 694 695 696
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

698
  $url = url($path, $options);
Kjartan's avatar
Kjartan committed
699

700
  header('Location: ' . $url, TRUE, $http_response_code);
701 702

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

Dries's avatar
 
Dries committed
708
/**
709
 * Performs an HTTP request.
Dries's avatar
 
Dries committed
710
 *
711 712
 * 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
713 714 715
 *
 * @param $url
 *   A string containing a fully qualified URI.
716 717 718 719 720 721 722 723 724 725 726 727
 * @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().
728
 *
729 730 731 732 733 734 735 736 737 738
 * @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.
739 740
 *   - redirect_url: If redirected, a string containing the URL of the redirect
 *     target.
741 742 743 744 745
 *   - 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
746
 */
747
function drupal_http_request($url, array $options = array()) {
748
  $result = new stdClass();
Dries's avatar
 
Dries committed
749

750 751 752 753
  // Parse the URL and make sure we can handle the schema.
  $uri = @parse_url($url);

  if ($uri == FALSE) {
754
    $result->error = 'unable to parse URL';
755
    $result->code = -1001;
756 757 758
    return $result;
  }

759 760 761 762 763
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
    $result->code = -1002;
    return $result;
  }
764

765 766 767 768 769 770 771 772
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
773 774
    'timeout' => 30.0,
    'context' => NULL,
775
  );
776 777 778 779 780 781

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

782 783
  // stream_socket_client() requires timeout to be a float.
  $options['timeout'] = (float) $options['timeout'];
784

785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
  // Use a proxy if one is defined and the host is not on the excluded list.
  $proxy_server = variable_get('proxy_server', '');
  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.
    if ($proxy_username = variable_get('proxy_username', '')) {
      $proxy_password = variable_get('proxy_password', '');
      $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.
    $proxy_user_agent = variable_get('proxy_user_agent', '');
    // 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
812
  switch ($uri['scheme']) {
813 814 815 816 817 818 819 820
    case 'proxy':
      // Make the socket connection to a proxy server.
      $socket = 'tcp://' . $proxy_server . ':' . variable_get('proxy_port', 8080);
      // 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
821
    case 'http':
822
    case 'feed':
Dries's avatar
Dries committed
823
      $port = isset($uri['port']) ? $uri['port'] : 80;
824 825 826 827 828
      $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
829
      break;
830

Dries's avatar
 
Dries committed
831
    case 'https':
832
      // Note: Only works when PHP is compiled with OpenSSL support.
Dries's avatar
Dries committed
833
      $port = isset($uri['port']) ? $uri['port'] : 443;
834 835
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
Dries's avatar
 
Dries committed
836
      break;
837

Dries's avatar
 
Dries committed
838
    default:
839
      $result->error = 'invalid schema ' . $uri['scheme'];
840
      $result->code = -1003;
Dries's avatar
 
Dries committed
841 842 843
      return $result;
  }

844 845 846 847 848 849 850 851
  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
852
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
853
  if (!$fp) {
854 855
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
856
    $result->code = -$errno;
857
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
Dries's avatar
 
Dries committed
858 859 860
    return $result;
  }

Dries's avatar
 
Dries committed
861
  // Construct the path to act on.
Dries's avatar
Dries committed
862 863
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
864
    $path .= '?' . $uri['query'];
Dries's avatar
 
Dries committed
865 866
  }

867 868 869 870
  // 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.
871 872 873
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
874 875 876
  }

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

881 882 883 884 885 886
  // 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.
887 888 889
  $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']);
890 891
  }

892
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
893
  foreach ($options['headers'] as $name => $value) {
894
    $request .= $name . ': ' . trim($value) . "\r\n";
Dries's avatar
 
Dries committed
895
  }
896
  $request .= "\r\n" . $options['data'];
Dries's avatar
 
Dries committed
897
  $result->request = $request;
898 899 900 901 902 903
  // 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
904

905 906 907 908 909
  // 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'];
910
  $response = '';
911 912

  while ($alive) {
913 914 915
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
916 917
      $info['timed_out'] = TRUE;
      break;
918 919
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
920 921 922 923
    $chunk = fread($fp, 1024);
    $response .= $chunk;
    $info = stream_get_meta_data($fp);
    $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
Dries's avatar
 
Dries committed
924 925 926
  }
  fclose($fp);

927 928 929 930 931
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
932
  // Parse response headers from the response body.
933 934 935
  // 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);
936
  $response = preg_split("/\r\n|\n|\r/", $response);
937

938
  // Parse the response status line.
939 940 941 942
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

Dries's avatar
 
Dries committed
943 944
  $result->headers = array();

945 946
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
947 948 949
    list($name, $value) = explode(':', $line, 2);
    $name = strtolower($name);
    if (isset($result->headers[$name]) && $name == 'set-cookie') {
950 951
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
952
      $result->headers[$name] .= ',' . trim($value);
953 954
    }
    else {
955
      $result->headers[$name] = trim($value);
956
    }
Dries's avatar
 
Dries committed
957 958 959
  }

  $responses = array(
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
    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
1000
  );
1001 1002
  // 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
1003 1004 1005
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
1006
  $result->code = $code;
Dries's avatar
 
Dries committed
1007 1008 1009 1010 1011 1012 1013 1014

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
1015
      $location = $result->headers['location'];
1016 1017 1018 1019 1020 1021
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
      elseif ($options['max_redirects']) {
1022 1023 1024
        // Redirect to the new location.
        $options['max_redirects']--;
        $result = drupal_http_request($location, $options);
1025
        $result->redirect_code = $code;
Dries's avatar
 
Dries committed
1026
      }
1027 1028 1029
      if (!isset($result->redirect_url)) {
        $result->redirect_url = $location;
      }
Dries's avatar
 
Dries committed
1030 1031
      break;
    default:
1032
      $result->error = $status_message;
Dries's avatar
 
Dries committed
1033 1034 1035 1036
  }

  return $result;
}
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048

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

Dries's avatar
 
Dries committed
1049
/**
1050
 * @} End of "defgroup http_handling".
Dries's avatar
 
Dries committed
1051
 */
Dries's avatar
 
Dries committed
1052

Kjartan's avatar
Kjartan committed
1053
/**
Dries's avatar
 
Dries committed
1054
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
1055
 * @{
Dries's avatar
 
Dries committed
1056
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
1057 1058
 */

1059
/**
1060
 * Verifies the syntax of the given e-mail address.
Dries's avatar
 
Dries committed
1061
 *
1062
 * See @link http://tools.ietf.org/html/rfc5321 RFC 5321 @endlink for details.
1063
 *
Dries's avatar
 
Dries committed
1064
 * @param $mail
1065
 *   A string containing an e-mail address.
1066
 *
Dries's avatar
 
Dries committed
1067
 * @return
Dries's avatar
 
Dries committed
1068
 *   TRUE if the address is in a valid format.
1069
 */
Dries's avatar
 
Dries committed
1070
function valid_email_address($mail) {
1071
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
1072 1073
}

Dries's avatar
 
Dries committed
1074
/**
1075
 * Verifies the syntax of the given URL.
Dries's avatar
 
Dries committed
1076
 *
1077 1078
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
1079
 * Valid values per RFC 3986.
Dries's avatar
 
Dries committed
1080
 * @param $url
Dries's avatar
 
Dries committed
1081
 *   The URL to verify.
Dries's avatar
 
Dries committed
1082
 * @param $absolute
Dries's avatar
 
Dries committed
1083
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
1084
 *
Dries's avatar
 
Dries committed
1085
 * @return
Dries's avatar
 
Dries committed
1086
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
1087
 */
Dries's avatar
 
Dries committed
1088
function valid_url($url, $absolute = FALSE) {
1089
  if ($absolute) {
1090
    return (bool)preg_match("
1091
      /^                                                      # Start at the beginning of the text
1092
      (?:ftp|https?|feed):\/\/                                # Look for ftp, http, https or feed schemes
1093 1094 1095
      (?:                                                     # Userinfo (optional) which is typically
        (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)*      # a username or a username and password
        (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@          # combination
1096
      )?
1097 1098 1099 1100 1101 1102
      (?:
        (?:[a-z0-9\-\.]|%[0-9a-f]{2})+                        # A domain name or a IPv4 address
        |(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\])         # or a well formed IPv6 address
      )
      (?::[0-9]+)?                                            # Server port number (optional)
      (?:[\/|\?]
1103
        (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})   # The path and query (optional)
1104
      *)?
1105
    $/xi", $url);
1106 1107
  }
  else {
1108
    return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
1109
  }
Dries's avatar
 
Dries committed
1110 1111
}

1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
/**
 * Verifies that a number is a multiple of a given step.
 *
 * The implementation assumes it is dealing with IEEE 754 double precision
 * floating point numbers that are used by PHP on most systems.
 *
 * This is based on the number/range verification methods of webkit.
 *
 * @param $value
 *   The value that needs to be checked.
 * @param $step
 *   The step scale factor. Must be positive.
 * @param $offset
 *   (optional) An offset, to which the difference must be a multiple of the
 *   given step.
 *
 * @return bool
 *   TRUE if no step mismatch has occured, or FALSE otherwise.
 *
 * @see http://opensource.apple.com/source/WebCore/WebCore-1298/html/NumberInputType.cpp
 */
function valid_number_step($value, $step, $offset = 0.0) {
  $double_value = (double) abs($value - $offset);

  // The fractional part of a double has 53 bits. The greatest number that could
  // be represented with that is 2^53. If the given value is even bigger than
  // $step * 2^53, then dividing by $step will result in a very small remainder.
  // Since that remainder can't even be represented with a single precision
  // float the following computation of the remainder makes no sense and we can
  // safely ignore it instead.
  if ($double_value / pow(2.0, 53) > $step) {
    return TRUE;
  }

  // Now compute that remainder of a division by $step.
  $remainder = (double) abs($double_value - $step * round($double_value / $step));

  // $remainder is a double precision floating point number. Remainders that
  // can't be represented with single precision floats are acceptable. The
  // fractional part of a float has 24 bits. That means remainders smaller than
  // $step * 2^-24 are acceptable.
  $computed_acceptable_error = (double)($step / pow(2.0, 24));

  return $computed_acceptable_error >= $remainder || $remainder >= ($step - $computed_acceptable_error);
}

1158 1159 1160 1161
/**
 * @} End of "defgroup validation".
 */

Dries's avatar
 
Dries committed
1162
/**
1163
 * Registers an event for the current visitor to the flood control mechanism.
Dries's avatar
 
Dries committed
1164 1165
 *
 * @param $name
1166
 *   The name of an event.
1167 1168 1169