common.inc 283 KB
Newer Older
Dries's avatar
Dries committed
1
<?php
2
// $Id$
Dries's avatar
Dries committed
3

4 5 6 7 8 9 10 11
/**
 * @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.
 */

12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/**
 * @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
 *
40
 * @}
41 42
 */

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
/**
 * Return status for saving which involved creating a new item.
 */
define('SAVED_NEW', 1);

/**
 * Return status for saving which involved an update to an existing item.
 */
define('SAVED_UPDATED', 2);

/**
 * Return status for saving which deleted an existing item.
 */
define('SAVED_DELETED', 3);

58
/**
59
 * The default group for system CSS files added to the page.
60 61 62 63
 */
define('CSS_SYSTEM', -100);

/**
64
 * The default group for module CSS files added to the page.
65 66 67 68
 */
define('CSS_DEFAULT', 0);

/**
69
 * The default group for theme CSS files added to the page.
70 71 72
 */
define('CSS_THEME', 100);

73
/**
74 75
 * The default group for JavaScript libraries, settings or jQuery plugins added
 * to the page.
76 77 78 79
 */
define('JS_LIBRARY', -100);

/**
80
 * The default group for module JavaScript code added to the page.
81 82 83 84
 */
define('JS_DEFAULT', 0);

/**
85
 * The default group for theme JavaScript code added to the page.
86 87 88
 */
define('JS_THEME', 100);

89 90 91 92 93 94
/**
 * Error code indicating that the request made by drupal_http_request() exceeded
 * the specified timeout.
 */
define('HTTP_REQUEST_TIMEOUT', 1);

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
/**
 * Constants defining cache granularity for blocks and renderable arrays.
 *
 * Modules specify the caching patterns for their blocks using binary
 * combinations of these constants in their hook_block_info():
 *   $block[delta]['cache'] = DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE;
 * DRUPAL_CACHE_PER_ROLE is used as a default when no caching pattern is
 * specified. Use DRUPAL_CACHE_CUSTOM to disable standard block cache and
 * implement
 *
 * The block cache is cleared in cache_clear_all(), and uses the same clearing
 * policy than page cache (node, comment, user, taxonomy added or updated...).
 * Blocks requiring more fine-grained clearing might consider disabling the
 * built-in block cache (DRUPAL_NO_CACHE) and roll their own.
 *
 * Note that user 1 is excluded from block caching.
 */

/**
 * 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.
 */
define('DRUPAL_NO_CACHE', -1);

/**
 * The block is handling its own caching in its hook_block_view(). From the
 * perspective of the block cache system, this is equivalent to DRUPAL_NO_CACHE.
 * Useful when time based expiration is needed or a site uses a node access
 * which invalidates standard block cache.
 */
define('DRUPAL_CACHE_CUSTOM', -2);

/**
 * The block or element can change depending on the roles the user viewing the
 * page belongs to. This is the default setting for blocks, used when the block
 * does not specify anything.
 */
define('DRUPAL_CACHE_PER_ROLE', 0x0001);

/**
 * The block or element can change depending on the user viewing the page.
 * 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.
 */
define('DRUPAL_CACHE_PER_USER', 0x0002);

/**
 * The block or element can change depending on the page being viewed.
 */
define('DRUPAL_CACHE_PER_PAGE', 0x0004);

/**
 * The block or element is the same for every user on every page where it is visible.
 */
define('DRUPAL_CACHE_GLOBAL', 0x0008);

154
/**
155
 * Add content to a specified region.
156 157
 *
 * @param $region
158
 *   Page region the content is added to.
159
 * @param $data
160
 *   Content to be added.
161
 */
162
function drupal_add_region_content($region = NULL, $data = NULL) {
163 164
  static $content = array();

165
  if (isset($region) && isset($data)) {
166 167 168 169 170 171
    $content[$region][] = $data;
  }
  return $content;
}

/**
172
 * Get assigned content for a given region.
173 174
 *
 * @param $region
175 176
 *   A specified region to fetch content for. If NULL, all regions will be
 *   returned.
177
 * @param $delimiter
178
 *   Content to be inserted between imploded array elements.
179
 */
180 181
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  $content = drupal_add_region_content();
182 183
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
184
      return implode($delimiter, $content[$region]);
185
    }
186 187 188 189
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
190
        $content[$region] = implode($delimiter, $content[$region]);
191 192 193 194 195 196
      }
    }
    return $content;
  }
}

197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
/**
 * Get the name of the currently active install profile.
 *
 * 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
 * table contains the name of the current profile, and we can call variable_get()
 * to determine what one is active.
 *
 * @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 {
216
    $profile = variable_get('install_profile', 'standard');
217 218 219 220 221 222
  }

  return $profile;
}


223
/**
224
 * Set the breadcrumb trail for the current page.
225
 *
226 227 228
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
229
 */
230
function drupal_set_breadcrumb($breadcrumb = NULL) {
231
  $stored_breadcrumb = &drupal_static(__FUNCTION__);
232

233
  if (isset($breadcrumb)) {
234 235 236 237 238
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

239 240 241
/**
 * Get the breadcrumb trail for the current page.
 */
242 243 244
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

245
  if (!isset($breadcrumb)) {
246 247 248 249 250 251
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

252
/**
253
 * Returns a string containing RDF namespace declarations for use in XML and
254
 * XHTML output.
255 256 257
 */
function drupal_get_rdf_namespaces() {
  $xml_rdf_namespaces = array();
258 259 260 261 262 263

  // Serializes the RDF namespaces in XML namespace syntax.
  if (function_exists('rdf_get_namespaces')) {
    foreach (rdf_get_namespaces() as $prefix => $uri) {
      $xml_rdf_namespaces[] = 'xmlns:' . $prefix . '="' . $uri . '"';
    }
264
  }
265
  return count($xml_rdf_namespaces) ? "\n  " . implode("\n  ", $xml_rdf_namespaces) : '';
266 267
}

Dries's avatar
Dries committed
268
/**
269
 * Add output to the head tag of the HTML page.
270
 *
271 272 273 274 275 276 277 278 279 280 281 282 283 284
 * This function can be called as long the headers aren't sent. Pass no
 * 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
285
 */
286 287
function drupal_add_html_head($data = NULL, $key = NULL) {
  $stored_head = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
288

289 290 291 292 293 294 295 296 297 298
  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
299 300 301 302
  }
  return $stored_head;
}

303
/**
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
 * 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(
      'http-equiv' => 'Content-Type',
      'content' => 'text/html; charset=utf-8',
    ),
    // 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;
}

/**
 * Retrieve output to be displayed in the HEAD tag of the HTML page.
338
 */
Dries's avatar
Dries committed
339
function drupal_get_html_head() {
340 341 342
  $elements = drupal_add_html_head();
  drupal_alter('html_head', $elements);
  return drupal_render($elements);
Dries's avatar
Dries committed
343 344
}

345
/**
346 347
 * Add a feed URL for the current page.
 *
348 349
 * This function can be called as long the HTML header hasn't been sent.
 *
350
 * @param $url
351
 *   An internal system path or a fully qualified external URL of the feed.
352
 * @param $title
353
 *   The title of the feed.
354
 */
355
function drupal_add_feed($url = NULL, $title = '') {
356
  $stored_feed_links = &drupal_static(__FUNCTION__, array());
357

358
  if (isset($url)) {
359
    $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
360

361 362 363 364 365 366 367 368
    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)),
    ));
369 370 371 372 373 374 375 376
  }
  return $stored_feed_links;
}

/**
 * Get the feed URLs for the current page.
 *
 * @param $delimiter
377
 *   A delimiter to split feeds by.
378 379 380 381 382 383
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

384
/**
385
 * @defgroup http_handling HTTP handling
386
 * @{
387
 * Functions to properly handle HTTP responses.
388 389
 */

390
/**
391
 * Process a URL query parameter array to remove unwanted elements.
392 393
 *
 * @param $query
394
 *   (optional) An array to be processed. Defaults to $_GET.
395
 * @param $exclude
396 397
 *   (optional) A list of $query array keys to remove. Use "parent[child]" to
 *   exclude nested items. Defaults to array('q').
398
 * @param $parent
399 400
 *   Internal use only. Used to build the $query array key for nested items.
 *
401
 * @return
402
 *   An array containing query parameters, which can be used for url().
403
 */
404 405 406 407 408 409 410 411 412 413 414 415
function drupal_get_query_parameters(array $query = NULL, array $exclude = array('q'), $parent = '') {
  // 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);
  }
416

417
  $params = array();
418
  foreach ($query as $key => $value) {
419 420 421
    $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
    if (isset($exclude[$string_key])) {
      continue;
422 423
    }

424 425 426 427 428
    if (is_array($value)) {
      $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
    }
    else {
      $params[$key] = $value;
429
    }
430 431 432 433 434
  }

  return $params;
}

435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
/**
 * Split an URL-encoded query string into an array.
 *
 * @param $query
 *   The query string to split.
 *
 * @return
 *   An array of url decoded couples $param_name => $value.
 */
function drupal_get_query_array($query) {
  $result = array();
  if (!empty($query)) {
    foreach (explode('&', $query) as $param) {
      $param = explode('=', $param);
      $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
    }
  }
  return $result;
}

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
/**
 * Parse an array into a valid, rawurlencoded query string.
 *
 * 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));
478

479
    // Recurse into children.
480
    if (is_array($value)) {
481 482 483 484 485
      $params[] = drupal_http_build_query($value, $key);
    }
    // If a query parameter value is NULL, only append its key.
    elseif (!isset($value)) {
      $params[] = $key;
486 487
    }
    else {
488 489
      // For better readability of paths in query strings, we decode slashes.
      $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
490 491 492 493 494 495
    }
  }

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

496
/**
497
 * Prepare a 'destination' URL query parameter for use in combination with drupal_goto().
498
 *
499 500 501 502
 * 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.
503 504 505 506
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
507 508 509 510 511 512
  $destination = &drupal_static(__FUNCTION__);

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

513
  if (isset($_GET['destination'])) {
514
    $destination = array('destination' => $_GET['destination']);
515 516
  }
  else {
517 518
    $path = $_GET['q'];
    $query = drupal_http_build_query(drupal_get_query_parameters());
519
    if ($query != '') {
520
      $path .= '?' . $query;
521
    }
522 523 524 525 526 527
    $destination = array('destination' => $path);
  }
  return $destination;
}

/**
528 529 530 531 532
 * Wrapper around parse_url() to parse a system URL string into an associative array, suitable for url().
 *
 * This function should only be used for URLs that have been generated by the
 * system, resp. url(). It should not be used for URLs that come from external
 * sources, or URLs that link to external resources.
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 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
 *
 * 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 {
586 587 588 589 590
    // 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);
591 592 593 594 595 596 597
    if (isset($parts['query'])) {
      parse_str($parts['query'], $options['query']);
    }
    if (isset($parts['fragment'])) {
      $options['fragment'] = $parts['fragment'];
    }
  }
598 599 600 601 602 603 604
  // The 'q' parameter contains the path of the current page if clean URLs are
  // disabled. It overrides the 'path' of the URL when present, even if clean
  // URLs are enabled, due to how Apache rewriting rules work.
  if (isset($options['query']['q'])) {
    $options['path'] = $options['query']['q'];
    unset($options['query']['q']);
  }
605 606 607 608 609

  return $options;
}

/**
610
 * Encodes a Drupal path for use in a URL.
611
 *
612
 * For aesthetic reasons slashes are not escaped.
613
 *
614 615
 * Note that url() takes care of calling this function, so a path passed to that
 * function should not be encoded in advance.
616 617
 *
 * @param $path
618
 *   The Drupal path to encode.
619 620
 */
function drupal_encode_path($path) {
621
  return str_replace('%2F', '/', rawurlencode($path));
622 623
}

624
/**
625
 * Send the user to a different Drupal page.
626
 *
627 628
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
629
 *
630
 * Usually the redirected URL is constructed from this function's input
631
 * parameters. However you may override that behavior by setting a
632
 * destination in either the $_REQUEST-array (i.e. by using
633
 * the query string of an URI) This is used to direct the user back to
634
 * the proper page after completing a form. For example, after editing
635
 * a post on the 'admin/content'-page or after having logged on using the
636
 * 'user login'-block in a sidebar. The function drupal_get_destination()
637 638
 * can be used to help set the destination URL.
 *
639 640
 * Drupal will ensure that messages set by drupal_set_message() and other
 * session data are written to the database before the user is redirected.
641
 *
642 643
 * This function ends the request; use it instead of a return in your menu
 * callback.
644 645
 *
 * @param $path
646
 *   A Drupal path or a full URL.
647 648
 * @param $options
 *   An associative array of additional URL options to pass to url().
649 650 651 652 653 654 655 656
 * @param $http_response_code
 *   Valid values for an actual "goto" as per RFC 2616 section 10.3 are:
 *   - 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
657
 *   - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
658
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
659
 *   supported.
660
 *
661
 * @see drupal_get_destination()
662
 * @see url()
663
 */
664 665
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  // A destination in $_GET always overrides the function arguments.
666 667
  // 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'])) {
668
    $destination = drupal_parse_url($_GET['destination']);
669 670 671
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
672 673
  }

674 675 676 677
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

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

679
  $url = url($path, $options);
680

681
  header('Location: ' . $url, TRUE, $http_response_code);
682 683

  // The "Location" header sends a redirect status code to the HTTP daemon. In
684 685
  // some cases this can be wrong, so we make sure none of the code below the
  // drupal_goto() call gets executed upon redirection.
686
  drupal_exit($url);
687 688
}

689
/**
690 691 692 693 694 695
 * Deliver a "site is under maintenance" message to the browser.
 *
 * Page callback functions wanting to report a "site offline" message should
 * return MENU_SITE_OFFLINE instead of calling drupal_site_offline(). However,
 * functions that are invoked in contexts where that return value might not
 * bubble up to menu_execute_active_handler() should call drupal_site_offline().
696 697
 */
function drupal_site_offline() {
698
  drupal_deliver_page(MENU_SITE_OFFLINE);
699 700
}

701
/**
702 703 704 705 706 707
 * Deliver a "page not found" error to the browser.
 *
 * Page callback functions wanting to report a "page not found" message should
 * return MENU_NOT_FOUND instead of calling drupal_not_found(). However,
 * functions that are invoked in contexts where that return value might not
 * bubble up to menu_execute_active_handler() should call drupal_not_found().
708
 */
709
function drupal_not_found() {
710
  drupal_deliver_page(MENU_NOT_FOUND);
711
}
712

713
/**
714 715 716 717 718 719
 * Deliver a "access denied" error to the browser.
 *
 * Page callback functions wanting to report an "access denied" message should
 * return MENU_ACCESS_DENIED instead of calling drupal_access_denied(). However,
 * functions that are invoked in contexts where that return value might not
 * bubble up to menu_execute_active_handler() should call drupal_access_denied().
720 721
 */
function drupal_access_denied() {
722
  drupal_deliver_page(MENU_ACCESS_DENIED);
723 724
}

725
/**
726
 * Perform an HTTP request.
727
 *
728 729
 * This is a flexible and powerful HTTP client implementation. Correctly
 * handles GET, POST, PUT or any other HTTP requests. Handles redirects.
730 731 732
 *
 * @param $url
 *   A string containing a fully qualified URI.
733 734 735 736 737 738 739 740 741 742 743 744
 * @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().
745
 *
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
 * @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.
 *   - redirect_url: If redirected, a string containing the redirection location.
 *   - 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.
762
 */
763
function drupal_http_request($url, array $options = array()) {
764
  $result = new stdClass();
765

766 767 768 769
  // Parse the URL and make sure we can handle the schema.
  $uri = @parse_url($url);

  if ($uri == FALSE) {
770
    $result->error = 'unable to parse URL';
771
    $result->code = -1001;
772 773 774
    return $result;
  }

775 776 777 778 779
  if (!isset($uri['scheme'])) {
    $result->error = 'missing schema';
    $result->code = -1002;
    return $result;
  }
780

781 782 783 784 785 786 787 788
  timer_start(__FUNCTION__);

  // Merge the default options.
  $options += array(
    'headers' => array(),
    'method' => 'GET',
    'data' => NULL,
    'max_redirects' => 3,
789 790
    'timeout' => 30.0,
    'context' => NULL,
791
  );
792 793
  // stream_socket_client() requires timeout to be a float.
  $options['timeout'] = (float) $options['timeout'];
794

795 796
  switch ($uri['scheme']) {
    case 'http':
797
    case 'feed':
798
      $port = isset($uri['port']) ? $uri['port'] : 80;
799 800 801 802 803
      $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 : '');
804 805
      break;
    case 'https':
806
      // Note: Only works when PHP is compiled with OpenSSL support.
807
      $port = isset($uri['port']) ? $uri['port'] : 443;
808 809
      $socket = 'ssl://' . $uri['host'] . ':' . $port;
      $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
810 811
      break;
    default:
812
      $result->error = 'invalid schema ' . $uri['scheme'];
813
      $result->code = -1003;
814 815 816
      return $result;
  }

817 818 819 820 821 822 823 824
  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']);
  }

825
  // Make sure the socket opened properly.
826
  if (!$fp) {
827 828
    // When a network error occurs, we use a negative number so it does not
    // clash with the HTTP status codes.
829
    $result->code = -$errno;
830
    $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
831 832 833 834

    // Mark that this request failed. This will trigger a check of the web
    // server's ability to make outgoing HTTP requests the next time that
    // requirements checking is performed.
835
    // See system_requirements()
836 837
    variable_set('drupal_http_request_fails', TRUE);

838 839 840
    return $result;
  }

841
  // Construct the path to act on.
842 843
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
844
    $path .= '?' . $uri['query'];
845 846
  }

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

852 853 854 855
  // 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.
856 857 858
  $content_length = strlen($options['data']);
  if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
    $options['headers']['Content-Length'] = $content_length;
859 860 861
  }

  // If the server URL has a user then attempt to use basic authentication.
862
  if (isset($uri['user'])) {
863
    $options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (!empty($uri['pass']) ? ":" . $uri['pass'] : ''));
864 865
  }

866 867 868 869 870 871
  // 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.
872 873 874
  $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']);
875 876
  }

877
  $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
878
  foreach ($options['headers'] as $name => $value) {
879
    $request .= $name . ': ' . trim($value) . "\r\n";
880
  }
881
  $request .= "\r\n" . $options['data'];
882
  $result->request = $request;
883 884 885 886 887 888
  // 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);
  }
889

890 891 892 893 894
  // 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'];
895
  $response = '';
896 897

  while ($alive) {
898 899 900
    // Calculate how much time is left of the original timeout value.
    $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
    if ($timeout <= 0) {
901 902
      $info['timed_out'] = TRUE;
      break;
903 904
    }
    stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
905 906 907 908
    $chunk = fread($fp, 1024);
    $response .= $chunk;
    $info = stream_get_meta_data($fp);
    $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
909 910 911
  }
  fclose($fp);

912 913 914 915 916
  if ($info['timed_out']) {
    $result->code = HTTP_REQUEST_TIMEOUT;
    $result->error = 'request timed out';
    return $result;
  }
917 918 919
  // Parse response headers from the response body.
  list($response, $result->data) = explode("\r\n\r\n", $response, 2);
  $response = preg_split("/\r\n|\n|\r/", $response);
920

921
  // Parse the response status line.
922 923 924 925
  list($protocol, $code, $status_message) = explode(' ', trim(array_shift($response)), 3);
  $result->protocol = $protocol;
  $result->status_message = $status_message;

926 927
  $result->headers = array();

928 929
  // Parse the response headers.
  while ($line = trim(array_shift($response))) {
930 931 932
    list($name, $value) = explode(':', $line, 2);
    $name = strtolower($name);
    if (isset($result->headers[$name]) && $name == 'set-cookie') {
933 934
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
935
      $result->headers[$name] .= ',' . trim($value);
936 937
    }
    else {
938
      $result->headers[$name] = trim($value);
939
    }
940 941 942
  }

  $responses = array(
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
    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',
983
  );
984 985
  // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  // base code in their class.
986 987 988
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }
989
  $result->code = $code;
990 991 992 993 994 995 996 997

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
998
      $location = $result->headers['location'];
999 1000 1001 1002 1003 1004
      $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
      if ($options['timeout'] <= 0) {
        $result->code = HTTP_REQUEST_TIMEOUT;
        $result->error = 'request timed out';
      }
      elseif ($options['max_redirects']) {
1005 1006 1007
        // Redirect to the new location.
        $options['max_redirects']--;
        $result = drupal_http_request($location, $options);
1008
        $result->redirect_code = $code;
1009 1010 1011 1012
      }
      $result->redirect_url = $location;
      break;
    default:
1013
      $result->error = $status_message;
1014 1015 1016 1017
  }

  return $result;
}
1018 1019 1020
/**
 * @} End of "HTTP handling".
 */
1021

1022
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
1023
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
1024 1025 1026
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
1027
    $item = stripslashes($item);
1028 1029 1030
  }
}

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
/**
 * Helper function to strip slashes from $_FILES skipping over the tmp_name keys
 * since PHP generates single backslashes for file paths on Windows systems.
 *
 * tmp_name does not have backslashes added see
 * http://php.net/manual/en/features.file-upload.php#42280
 */
function _fix_gpc_magic_files(&$item, $key) {
  if ($key != 'tmp_name') {
    if (is_array($item)) {
      array_walk($item, '_fix_gpc_magic_files');
    }
    else {
      $item = stripslashes($item);
    }
  }
}

1049
/**
1050
 * Fix double-escaping problems caused by "magic quotes" in some PHP installations.
1051
 */
1052
function fix_gpc_magic() {
1053
  $fixed = &drupal_static(__FUNCTION__, FALSE);
1054
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
1055 1056 1057 1058
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
1059
    array_walk($_FILES, '_fix_gpc_magic_files');
1060
    $fixed = TRUE;
Dries's avatar
Dries committed
1061
  }
1062 1063
}

1064
/**
1065
 * @defgroup validation Input validation
1066
 * @{
1067
 * Functions to validate user input.
1068 1069
 */

1070
/**
1071 1072 1073
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
1074
 *
1075
 * @param $mail
1076
 *   A string containing an e-mail address.
1077
 * @return
1078
 *   TRUE if the address is in a valid format.
1079
 */
1080
function valid_email_address($mail) {
1081
  return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
1082 1083
}

1084 1085 1086
/**
 * Verify the syntax of the given URL.
 *
1087 1088
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
1089
 * Valid values per RFC 3986.
1090
 * @param $url
1091
 *   The URL to verify.
1092
 * @param $absolute
1093
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
1094
 * @return
1095
 *   TRUE if the URL is in a valid format.
1096
 */
1097
function valid_url($url, $absolute = FALSE) {
1098
  if ($absolute) {
1099
    return (bool)preg_match("
1100
      /^                                                      # Start at the beginning of the text
1101
      (?:ftp|https?|feed):\/\/                                # Look for ftp, http, https or feed schemes
1102 1103 1104
      (?:                                                     # Userinfo (optional) which is typically
        (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)*      # a username or a username and password
        (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@          # combination
1105
      )?
1106 1107 1108 1109 1110 1111
      (?:
        (?:[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)
      (?:[\/|\?]
1112
        (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})   # The path and query (optional)
1113
      *)?
1114
    $/xi", $url);
1115 1116
  }
  else {
1117
    return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
1118
  }
1119 1120
}

1121 1122 1123 1124
/**
 * @} End of "defgroup validation".
 */

1125
/**
1126
 * Register an event for the current visitor to the flood control mechanism.
1127 1128
 *
 * @param $name
1129
 *   The name of an event.
1130 1131 1132 1133 1134
 * @param $window
 *   Optional number of seconds before this event expires. Defaults to 3600 (1
 *   hour). Typically uses the same value as the flood_is_allowed() $window
 *   parameter. Expired events are purged on cron run to prevent the flood table
 *   from growing indefinitely.
1135 1136
 * @param $identifier
 *   Optional identifier (defaults to the current user's IP address).
1137
 */
1138
function flood_register_event($name, $window = 3600, $identifier = NULL) {
1139 1140 1141
  if (!isset($identifier)) {
    $identifier = ip_address();
  }
1142 1143 1144
  db_insert('flood')
    ->fields(array(
      'event' => $name,
1145
      'identifier' => $identifier,
1146
      'timestamp' => REQUEST_TIME,
1147
      'expiration' => REQUEST_TIME + $window,
1148 1149
    ))
    ->execute();
1150 1151 1152
}

/**
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
 * Make the flood control mechanism forget about an event for the current visitor.
 *
 * @param $name
 *   The name of an event.
 * @param $identifier
 *   Optional identifier (defaults to the current user's IP address).
 */
function flood_clear_event($name, $identifier = NULL) {
  if (!isset($identifier)) {
    $identifier = ip_address();
  }
  db_delete('flood')
    ->condition('event', $name)
    ->condition('identifier', $identifier)
    ->execute();
}

/**
1171
 * Checks whether user is allowed to proceed with the specified event.
1172
 *
1173 1174 1175
 * Events can have thresholds saying that each user can only do that event
 * a certain number of times in a time window. This function verifies that the
 * current user has not exceeded this threshold.
1176 1177
 *
 * @param $name
1178
 *   The unique name of the event.
1179
 * @param $threshold
1180
 *   The maximum number of times each user can do this event per time window.
1181
 * @param $window
1182 1183
 *   Number of seconds in the time window for this event (default is 3600
 *   seconds, or 1 hour).
1184
 * @param $identifier
1185 1186
 *   Unique identifier of the current user. Defaults to their IP address.
 *
1187
 * @return
1188 1189
 *   TRUE if the user is allowed to proceed. FALSE if they have exceeded the
 *   threshold and should not be allowed to proceed.
1190
 */
1191 1192 1193 1194 1195
function flood_is_allowed($name, $threshold, $window = 3600, $identifier = NULL) {
  if (!isset($identifier)) {
    $identifier = ip_address();
  }
  $number = db_query("SELECT COUNT(*) FROM {flood} WHERE event = :event AND identifier = :identifier AND timestamp > :timestamp", array(
1196
    ':event' => $name,
1197 1198
    ':identifier' => $identifier,
    ':timestamp' => REQUEST_TIME - $window))
1199 1200
    ->fetchField();
  return ($number < $threshold);
1201 1202
}

1203 1204 1205 1206
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
1207 1208 1209
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
1210 1211
 */

Dries's avatar
Dries committed
1212
/**
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
 * Strips dangerous protocols (e.g. 'javascript:') from a URI.
 *
 * This function must be called for all URIs within user-entered input prior
 * to being output to an HTML attribute value. It is often called as part of
 * check_url() or filter_xss(), but those functions return an HTML-encoded
 * string, so this function can be called independently when the output needs to
 * be a plain-text string for passing to t(), l(), drupal_attributes(), or
 * another function that will call check_plain() separately.
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
 * @return
 *   A plain-text URI stripped of dangerous protocols. As with all plain-text
 *   strings, this return value must not be output to an HTML page without
 *   check_plain() being called on it. However, it can be passed to functions
 *   expecting plain-text strings.
 *
 * @see check_url()
 */
function drupal_strip_dangerous_protocols($uri) {
  static $allowed_protocols;

  if (!isset($allowed_protocols)) {
1237
    $allowed_protocols = array_flip(variable_get('filter_allowed_protocols', array('ftp', 'http', 'https', 'irc', 'mailto', 'news', 'nntp', 'rtsp', 'sftp', 'ssh', 'tel', 'telnet', 'webcal')));
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
  }

  // Iteratively remove any invalid protocol found.
  do {
    $before = $uri;
    $colonpos = strpos($uri, ':');
    if ($colonpos > 0) {
      // We found a colon, possibly a protocol. Verify.
      $protocol = substr($uri, 0, $colonpos);
      // If a colon is preceded by a slash, question mark or hash, it cannot
      // possibly be part of the URL scheme. This must be a relative URL, which
      // inherits the (safe) protocol of the base document.
      if (preg_match('![/?#]!', $protocol)) {
        break;
      }
      // Check if this is a disallowed protocol. Per RFC2616, section 3.2.3
      // (URI Comparison) scheme comparison must be case-insensitive.
      if (!isset($allowed_protocols[strtolower($protocol)])) {
        $uri = substr($uri, $colonpos + 1);
      }
    }
  } while ($before != $uri);

  return $uri;
}

/**
 * Strips dangerous protocols (e.g. 'javascript:') from a URI and encodes it for output to an HTML attribute value.
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
 * @return
 *   A URI stripped of dangerous protocols and encoded for output to an HTML
 *   attribute value. Because it is already encoded, it should not be set as a
 *   value within a $attributes array passed to drupal_attributes(), because
 *   drupal_attributes() expects those values to be plain-text strings. To pass
 *   a filtered URI to drupal_attributes(), call
 *   drupal_strip_dangerous_protocols() instead.
 *
 * @see drupal_strip_dangerous_protocols()