Newer
Older
/**
* @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.
*/
Dries Buytaert
committed
/**
* @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
*
* @}
Dries Buytaert
committed
*/
Steven Wittens
committed
/**
* 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);
Dries Buytaert
committed
/**
Dries Buytaert
committed
* The default group for system CSS files added to the page.
Dries Buytaert
committed
*/
define('CSS_SYSTEM', -100);
/**
Dries Buytaert
committed
* The default group for module CSS files added to the page.
Dries Buytaert
committed
*/
define('CSS_DEFAULT', 0);
/**
Dries Buytaert
committed
* The default group for theme CSS files added to the page.
Dries Buytaert
committed
*/
define('CSS_THEME', 100);
Angie Byron
committed
/**
Angie Byron
committed
* The default group for JavaScript and jQuery libraries added to the page.
Angie Byron
committed
*/
define('JS_LIBRARY', -100);
/**
Dries Buytaert
committed
* The default group for module JavaScript code added to the page.
Angie Byron
committed
*/
define('JS_DEFAULT', 0);
/**
Dries Buytaert
committed
* The default group for theme JavaScript code added to the page.
Angie Byron
committed
*/
define('JS_THEME', 100);
Dries Buytaert
committed
/**
Angie Byron
committed
* Error code indicating that the request exceeded the specified timeout.
*
* @see drupal_http_request()
Dries Buytaert
committed
*/
Dries Buytaert
committed
define('HTTP_REQUEST_TIMEOUT', -1);
Dries Buytaert
committed
/**
Jennifer Hodgdon
committed
* @defgroup block_caching Block Caching
* @{
* Constants that define each block's caching state.
*
Jennifer Hodgdon
committed
* 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.
*
* 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.
*/
/**
Angie Byron
committed
* 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);
/**
Angie Byron
committed
* The block is handling its own caching in its hook_block_view().
*
Jennifer Hodgdon
committed
* This setting is useful when time based expiration is needed or a site uses a
* node access which invalidates standard block cache.
*/
define('DRUPAL_CACHE_CUSTOM', -2);
/**
Angie Byron
committed
* 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.
*/
define('DRUPAL_CACHE_PER_ROLE', 0x0001);
/**
Angie Byron
committed
* The block or element can change depending on the user.
*
* 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);
/**
Angie Byron
committed
* The block or element is the same for every user and page that it is visible.
*/
define('DRUPAL_CACHE_GLOBAL', 0x0008);
Jennifer Hodgdon
committed
/**
* @} End of "defgroup block_caching".
*/
Angie Byron
committed
* Adds content to a specified region.
*
* @param $region
Dries Buytaert
committed
* Page region the content is added to.
Dries Buytaert
committed
* Content to be added.
Dries Buytaert
committed
function drupal_add_region_content($region = NULL, $data = NULL) {
static $content = array();
Dries Buytaert
committed
if (isset($region) && isset($data)) {
$content[$region][] = $data;
}
return $content;
}
/**
Angie Byron
committed
* Gets assigned content for a given region.
*
* @param $region
* A specified region to fetch content for. If NULL, all regions will be
* returned.
Dries Buytaert
committed
* Content to be inserted between imploded array elements.
Dries Buytaert
committed
function drupal_get_region_content($region = NULL, $delimiter = ' ') {
$content = drupal_add_region_content();
if (isset($region)) {
if (isset($content[$region]) && is_array($content[$region])) {
}
else {
foreach (array_keys($content) as $region) {
if (is_array($content[$region])) {
$content[$region] = implode($delimiter, $content[$region]);
}
}
return $content;
}
}
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Gets the name of the currently active installation profile.
Angie Byron
committed
*
* 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
Angie Byron
committed
* table contains the name of the current profile, and we can call
* variable_get() to determine what one is active.
Angie Byron
committed
*
* @return $profile
Jennifer Hodgdon
committed
* The name of the installation profile.
Angie Byron
committed
*/
function drupal_get_profile() {
global $install_state;
if (isset($install_state['parameters']['profile'])) {
$profile = $install_state['parameters']['profile'];
}
else {
Angie Byron
committed
$profile = variable_get('install_profile', 'standard');
Angie Byron
committed
}
return $profile;
}
Angie Byron
committed
* Sets the breadcrumb trail for the current page.
* @param $breadcrumb
* Array of links, starting with "home" and proceeding up to but not including
* the current page.
Dries Buytaert
committed
$stored_breadcrumb = &drupal_static(__FUNCTION__);
Dries Buytaert
committed
if (isset($breadcrumb)) {
$stored_breadcrumb = $breadcrumb;
}
return $stored_breadcrumb;
}
Angie Byron
committed
* Gets the breadcrumb trail for the current page.
function drupal_get_breadcrumb() {
$breadcrumb = drupal_set_breadcrumb();
Dries Buytaert
committed
if (!isset($breadcrumb)) {
$breadcrumb = menu_get_active_breadcrumb();
}
return $breadcrumb;
}
/**
* Returns a string containing RDF namespace declarations for use in XML and
Dries Buytaert
committed
* XHTML output.
*/
function drupal_get_rdf_namespaces() {
$xml_rdf_namespaces = array();
// 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 . '"';
}
}
Dries Buytaert
committed
return count($xml_rdf_namespaces) ? "\n " . implode("\n ", $xml_rdf_namespaces) : '';
}
Angie Byron
committed
* Adds output to the HEAD tag of the HTML page.
David Rothstein
committed
* This function can be called as long as 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()
function drupal_add_html_head($data = NULL, $key = NULL) {
$stored_head = &drupal_static(__FUNCTION__);
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;
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
* 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;
}
/**
Angie Byron
committed
* Retrieves output to be displayed in the HEAD tag of the HTML page.
$elements = drupal_add_html_head();
drupal_alter('html_head', $elements);
return drupal_render($elements);
Angie Byron
committed
* Adds a feed URL for the current page.
* This function can be called as long the HTML header hasn't been sent.
*
* An internal system path or a fully qualified external URL of the feed.
* @param $title
* The title of the feed.
function drupal_add_feed($url = NULL, $title = '') {
Dries Buytaert
committed
$stored_feed_links = &drupal_static(__FUNCTION__, array());
if (isset($url)) {
Dries Buytaert
committed
$stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
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)),
));
}
return $stored_feed_links;
}
/**
Angie Byron
committed
* Gets the feed URLs for the current page.
*
* @param $delimiter
* A delimiter to split feeds by.
*/
function drupal_get_feeds($delimiter = "\n") {
$feeds = drupal_add_feed();
return implode($delimiter, $feeds);
* @defgroup http_handling HTTP handling
Gerhard Killesreiter
committed
/**
Angie Byron
committed
* Processes a URL query parameter array to remove unwanted elements.
Gerhard Killesreiter
committed
*
* @param $query
Dries Buytaert
committed
* (optional) An array to be processed. Defaults to $_GET.
Gerhard Killesreiter
committed
* @param $exclude
Dries Buytaert
committed
* (optional) A list of $query array keys to remove. Use "parent[child]" to
* exclude nested items. Defaults to array('q').
Gerhard Killesreiter
committed
* @param $parent
Dries Buytaert
committed
* Internal use only. Used to build the $query array key for nested items.
*
Gerhard Killesreiter
committed
* @return
Dries Buytaert
committed
* An array containing query parameters, which can be used for url().
Gerhard Killesreiter
committed
*/
Dries Buytaert
committed
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);
}
Gerhard Killesreiter
committed
Dries Buytaert
committed
$params = array();
Gerhard Killesreiter
committed
foreach ($query as $key => $value) {
Dries Buytaert
committed
$string_key = ($parent ? $parent . '[' . $key . ']' : $key);
if (isset($exclude[$string_key])) {
continue;
Gerhard Killesreiter
committed
}
Dries Buytaert
committed
if (is_array($value)) {
$params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
}
else {
$params[$key] = $value;
Gerhard Killesreiter
committed
}
Dries Buytaert
committed
}
return $params;
}
Angie Byron
committed
/**
Angie Byron
committed
* Splits a URL-encoded query string into an array.
Angie Byron
committed
*
* @param $query
* The query string to split.
*
* @return
Jennifer Hodgdon
committed
* An array of URL decoded couples $param_name => $value.
Angie Byron
committed
*/
function drupal_get_query_array($query) {
$result = array();
if (!empty($query)) {
foreach (explode('&', $query) as $param) {
David Rothstein
committed
$param = explode('=', $param, 2);
Angie Byron
committed
$result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
}
}
return $result;
}
Dries Buytaert
committed
/**
Angie Byron
committed
* Parses an array into a valid, rawurlencoded query string.
Dries Buytaert
committed
*
* 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) {
David Rothstein
committed
$key = $parent ? $parent . rawurlencode('[' . $key . ']') : rawurlencode($key);
Gerhard Killesreiter
committed
Dries Buytaert
committed
// Recurse into children.
Gerhard Killesreiter
committed
if (is_array($value)) {
Dries Buytaert
committed
$params[] = drupal_http_build_query($value, $key);
}
// If a query parameter value is NULL, only append its key.
elseif (!isset($value)) {
$params[] = $key;
Gerhard Killesreiter
committed
}
else {
Dries Buytaert
committed
// For better readability of paths in query strings, we decode slashes.
$params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
Gerhard Killesreiter
committed
}
}
return implode('&', $params);
}
/**
Angie Byron
committed
* Prepares a 'destination' URL query parameter for use with drupal_goto().
* 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.
*
Jennifer Hodgdon
committed
* @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()
* @see drupal_goto()
*/
function drupal_get_destination() {
Dries Buytaert
committed
$destination = &drupal_static(__FUNCTION__);
if (isset($destination)) {
return $destination;
}
Dries Buytaert
committed
if (isset($_GET['destination'])) {
Dries Buytaert
committed
$destination = array('destination' => $_GET['destination']);
Dries Buytaert
committed
}
else {
Dries Buytaert
committed
$path = $_GET['q'];
$query = drupal_http_build_query(drupal_get_query_parameters());
Gerhard Killesreiter
committed
if ($query != '') {
$path .= '?' . $query;
Gerhard Killesreiter
committed
}
Dries Buytaert
committed
$destination = array('destination' => $path);
}
return $destination;
}
/**
* Parses a URL string into its path, query, and fragment components.
Angie Byron
committed
*
* This function splits both internal paths like @code node?b=c#d @endcode and
* external URLs like @code https://example.com/a?b=c#d @endcode into their
* component parts. See
* @link http://tools.ietf.org/html/rfc3986#section-3 RFC 3986 @endlink for an
* explanation of what the component parts are.
Dries Buytaert
committed
*
* Note that, unlike the RFC, when passed an external URL, this function
* groups the scheme, authority, and path together into the path component.
Dries Buytaert
committed
*
* @param string $url
* The internal path or external URL string to parse.
Dries Buytaert
committed
*
* @return array
* An associative array containing:
* - path: The path component of $url. If $url is an external URL, this
* includes the scheme, authority, and path.
* - query: An array of query parameters from $url, if they exist.
* - fragment: The fragment component from $url, if it exists.
Dries Buytaert
committed
*
* @see drupal_goto()
* @see l()
* @see url()
* @see http://tools.ietf.org/html/rfc3986
*
Dries Buytaert
committed
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
* @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 {
Dries Buytaert
committed
// 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);
Dries Buytaert
committed
if (isset($parts['query'])) {
parse_str($parts['query'], $options['query']);
}
if (isset($parts['fragment'])) {
$options['fragment'] = $parts['fragment'];
}
}
Angie Byron
committed
// 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
David Rothstein
committed
// URLs are enabled, due to how Apache rewriting rules work. The path
// parameter must be a string.
if (isset($options['query']['q']) && is_string($options['query']['q'])) {
Angie Byron
committed
$options['path'] = $options['query']['q'];
unset($options['query']['q']);
}
Dries Buytaert
committed
return $options;
}
/**
Dries Buytaert
committed
* Encodes a Drupal path for use in a URL.
Dries Buytaert
committed
*
Dries Buytaert
committed
* For aesthetic reasons slashes are not escaped.
Dries Buytaert
committed
*
Dries Buytaert
committed
* Note that url() takes care of calling this function, so a path passed to that
* function should not be encoded in advance.
Dries Buytaert
committed
*
* @param $path
Dries Buytaert
committed
* The Drupal path to encode.
Dries Buytaert
committed
*/
function drupal_encode_path($path) {
Drew Webber
committed
return str_replace('%2F', '/', rawurlencode((string) $path));
}
* Sends the user to a different page.
* This issues an on-site HTTP redirect. The function makes sure the redirected
* URL is formatted correctly.
* Usually the redirected URL is constructed from this function's input
* parameters. However you may override that behavior by setting a
* destination in either the $_REQUEST-array (i.e. by using
* the query string of an URI) This is used to direct the user back to
* the proper page after completing a form. For example, after editing
Dries Buytaert
committed
* a post on the 'admin/content'-page or after having logged on using the
* 'user login'-block in a sidebar. The function drupal_get_destination()
* can be used to help set the destination URL.
*
* Drupal will ensure that messages set by drupal_set_message() and other
* session data are written to the database before the user is redirected.
Angie Byron
committed
* This function ends the request; use it instead of a return in your menu
* callback.
Jennifer Hodgdon
committed
* (optional) A Drupal path or a full URL, which will be passed to url() to
* compute the redirect for the URL.
Angie Byron
committed
* @param $options
Jennifer Hodgdon
committed
* (optional) An associative array of additional URL options to pass to url().
* @param $http_response_code
Jennifer Hodgdon
committed
* (optional) The HTTP status code to use for the redirection, defaults to
* 302. The valid values for 3xx redirection status codes are defined in
Jennifer Hodgdon
committed
* @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.
Angie Byron
committed
*
* @see drupal_get_destination()
Angie Byron
committed
* @see url()
Angie Byron
committed
function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
// A destination in $_GET always overrides the function arguments.
// 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'])) {
Dries Buytaert
committed
$destination = drupal_parse_url($_GET['destination']);
// Double check the path derived by drupal_parse_url() is not external.
if (!url_is_external($destination['path'])) {
$path = $destination['path'];
}
Angie Byron
committed
$options['query'] = $destination['query'];
$options['fragment'] = $destination['fragment'];
}
David Rothstein
committed
// In some cases modules call drupal_goto(current_path()). We need to ensure
// that such a redirect is not to an external URL.
if ($path === current_path() && empty($options['external']) && url_is_external($path)) {
// Force url() to generate a non-external URL.
$options['external'] = FALSE;
}
Angie Byron
committed
drupal_alter('drupal_goto', $path, $options, $http_response_code);
// The 'Location' HTTP header must be absolute.
$options['absolute'] = TRUE;
Dries Buytaert
committed
Angie Byron
committed
$url = url($path, $options);
header('Location: ' . $url, TRUE, $http_response_code);
Dries Buytaert
committed
// The "Location" header sends a redirect status code to the HTTP daemon. In
// some cases this can be wrong, so we make sure none of the code below the
// drupal_goto() call gets executed upon redirection.
Dries Buytaert
committed
drupal_exit($url);
Dries Buytaert
committed
/**
Angie Byron
committed
* Delivers a "site is under maintenance" message to the browser.
Dries Buytaert
committed
*
* 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().
Dries Buytaert
committed
*/
function drupal_site_offline() {
Dries Buytaert
committed
drupal_deliver_page(MENU_SITE_OFFLINE);
Dries Buytaert
committed
}
Angie Byron
committed
* Delivers a "page not found" error to the browser.
Dries Buytaert
committed
*
* 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().
Dries Buytaert
committed
drupal_deliver_page(MENU_NOT_FOUND);
Angie Byron
committed
* Delivers an "access denied" error to the browser.
Dries Buytaert
committed
*
* 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
Angie Byron
committed
* bubble up to menu_execute_active_handler() should call
* drupal_access_denied().
Dries Buytaert
committed
drupal_deliver_page(MENU_ACCESS_DENIED);
Angie Byron
committed
* Performs an HTTP request.
Dries Buytaert
committed
* This is a flexible and powerful HTTP client implementation. Correctly
* handles GET, POST, PUT or any other HTTP requests. Handles redirects.
Dries Buytaert
committed
* @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'.
Drew Webber
committed
* - data: An array containing the values for the request body or a string
* containing the request body, formatted as
Drew Webber
committed
* 'param=value¶m=value&...'; to generate this, use
* drupal_http_build_query(). Defaults to NULL.
Dries Buytaert
committed
* - 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().
Angie Byron
committed
*
Dries Buytaert
committed
* @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.
Angie Byron
committed
* - redirect_url: If redirected, a string containing the URL of the redirect
* target.
Dries Buytaert
committed
* - 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.
Stefan Ruijsenaars
committed
*
Drew Webber
committed
* @see drupal_http_build_query()
Dries Buytaert
committed
function drupal_http_request($url, array $options = array()) {
David Rothstein
committed
// Allow an alternate HTTP client library to replace Drupal's default
// implementation.
$override_function = variable_get('drupal_http_request_function', FALSE);
if (!empty($override_function) && function_exists($override_function)) {
return $override_function($url, $options);
}
$result = new stdClass();
Angie Byron
committed
// Parse the URL and make sure we can handle the schema.
$uri = @parse_url($url);
if ($uri == FALSE) {
Dries Buytaert
committed
$result->error = 'unable to parse URL';
$result->code = -1001;
Dries Buytaert
committed
return $result;
}
Angie Byron
committed
if (!isset($uri['scheme'])) {
$result->error = 'missing schema';
$result->code = -1002;
return $result;
}
Dries Buytaert
committed
Dries Buytaert
committed
timer_start(__FUNCTION__);
// Merge the default options.
$options += array(
'headers' => array(),
'method' => 'GET',
'data' => NULL,
'max_redirects' => 3,
Dries Buytaert
committed
'timeout' => 30.0,
'context' => NULL,
Dries Buytaert
committed
);
// Merge the default headers.
$options['headers'] += array(
'User-Agent' => 'Drupal (+http://drupal.org/)',
);
Dries Buytaert
committed
// stream_socket_client() requires timeout to be a float.
$options['timeout'] = (float) $options['timeout'];
Dries Buytaert
committed
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
// 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;
}
}
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.
David Rothstein
committed
if (!isset($options['headers']['Host'])) {
$options['headers']['Host'] = $uri['host'];
$options['headers']['Host'] .= isset($uri['port']) && $uri['port'] != 80 ? ':' . $uri['port'] : '';
}
break;
Dries Buytaert
committed
case 'feed':
$port = isset($uri['port']) ? $uri['port'] : 80;
Dries Buytaert
committed
$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.
David Rothstein
committed
if (!isset($options['headers']['Host'])) {
$options['headers']['Host'] = $uri['host'] . ($port != 80 ? ':' . $port : '');
}
Dries Buytaert
committed
// Note: Only works when PHP is compiled with OpenSSL support.
$port = isset($uri['port']) ? $uri['port'] : 443;
Dries Buytaert
committed
$socket = 'ssl://' . $uri['host'] . ':' . $port;
David Rothstein
committed
if (!isset($options['headers']['Host'])) {
$options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
}
$result->error = 'invalid schema ' . $uri['scheme'];
$result->code = -1003;
Dries Buytaert
committed
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']);
}
Gábor Hojtsy
committed
// When a network error occurs, we use a negative number so it does not
// clash with the HTTP status codes.
Dries Buytaert
committed
$result->code = -$errno;
Dries Buytaert
committed
$result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
Dries Buytaert
committed
// 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.
Angie Byron
committed
// See system_requirements().
Dries Buytaert
committed
variable_set('drupal_http_request_fails', TRUE);
$path = isset($uri['path']) ? $uri['path'] : '/';
if (isset($uri['query'])) {
$path .= '?' . $uri['query'];
Drew Webber
committed
// Convert array $options['data'] to query string.
if (is_array($options['data'])) {
Drew Webber
committed
$options['data'] = drupal_http_build_query($options['data']);
Pol Dellaiera
committed
}
Dries Buytaert
committed
// 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.
Drew Webber
committed
$content_length = strlen((string) $options['data']);
if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
$options['headers']['Content-Length'] = $content_length;
Dries Buytaert
committed
}
// If the server URL has a user then attempt to use basic authentication.
if (isset($uri['user'])) {
David Rothstein
committed
$options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (isset($uri['pass']) ? ':' . $uri['pass'] : ':'));
}
Dries Buytaert
committed
// 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.
Dries Buytaert
committed
$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']);
Dries Buytaert
committed
}
Dries Buytaert
committed
$request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
Dries Buytaert
committed
foreach ($options['headers'] as $name => $value) {
Dries Buytaert
committed
$request .= $name . ': ' . trim($value) . "\r\n";
Dries Buytaert
committed
$request .= "\r\n" . $options['data'];
Dries Buytaert
committed
// 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 Buytaert
committed
// 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'];
Dries Buytaert
committed
while ($alive) {
Dries Buytaert
committed
// Calculate how much time is left of the original timeout value.
$timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
if ($timeout <= 0) {
Dries Buytaert
committed
$info['timed_out'] = TRUE;
break;
Dries Buytaert
committed
}
stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
Dries Buytaert
committed
$chunk = fread($fp, 1024);
$response .= $chunk;
$info = stream_get_meta_data($fp);
$alive = !$info['eof'] && !$info['timed_out'] && $chunk;