Newer
Older
Dries Buytaert
committed
// $Id$
/**
* @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.
*/
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);
Angie Byron
committed
/**
* The weight of JavaScript libraries, settings or jQuery plugins being
* added to the page.
*/
define('JS_LIBRARY', -100);
/**
* The default weight of JavaScript being added to the page.
*/
define('JS_DEFAULT', 0);
/**
* The weight of theme JavaScript code being added to the page.
*/
define('JS_THEME', 100);
/**
* Set content for a specified region.
*
* @param $region
* Page region the content is assigned to.
* @param $data
* Content to be set.
*/
function drupal_set_content($region = NULL, $data = NULL) {
static $content = array();
if (!is_null($region) && !is_null($data)) {
$content[$region][] = $data;
}
return $content;
}
/**
* Get assigned content.
*
* @param $region
* A specified region to fetch content for. If NULL, all regions will be
* returned.
* @param $delimiter
* Content to be inserted between exploded array elements.
*/
function drupal_get_content($region = NULL, $delimiter = ' ') {
$content = drupal_set_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;
}
}
* @param $breadcrumb
* Array of links, starting with "home" and proceeding up to but not including
* the current page.
function drupal_set_breadcrumb($breadcrumb = NULL) {
static $stored_breadcrumb;
if (!is_null($breadcrumb)) {
$stored_breadcrumb = $breadcrumb;
}
return $stored_breadcrumb;
}
function drupal_get_breadcrumb() {
$breadcrumb = drupal_set_breadcrumb();
if (is_null($breadcrumb)) {
$breadcrumb = menu_get_active_breadcrumb();
}
return $breadcrumb;
}
/**
Dries Buytaert
committed
* Return a string containing RDF namespaces for the <html> tag of an XHTML
* page.
*/
function drupal_get_rdf_namespaces() {
// Serialize the RDF namespaces used in RDFa annotation.
$xml_rdf_namespaces = array();
foreach (module_invoke_all('rdf_namespaces') as $prefix => $uri) {
$xml_rdf_namespaces[] = 'xmlns:' . $prefix . '="' . $uri . '"';
}
return implode("\n ", $xml_rdf_namespaces);
}
*/
function drupal_set_html_head($data = NULL) {
$stored_head .= $data . "\n";
/**
* Retrieve output to be displayed in the head tag of the HTML page.
*/
$output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
return $output . drupal_set_html_head();
}
* Reset the static variable which holds the aliases mapped for this request.
function drupal_clear_path_cache() {
drupal_lookup_path('wipe');
* Note: When sending a Content-Type header, always include a 'charset' type,
* too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
*/
function drupal_set_header($header = NULL) {
// We use an array to guarantee there are no leading or trailing delimiters.
// Otherwise, header('') could get called when serving the page later, which
// ends HTTP headers prematurely on some PHP versions.
static $stored_headers = array();
$stored_headers[] = $header;
return implode("\n", $stored_headers);
function drupal_get_headers() {
return drupal_set_header();
}
* Add a feed URL for the current page.
*
* This function can be called as long the HTML header hasn't been sent.
*
* A url for the feed.
* @param $title
* The title of the feed.
function drupal_add_feed($url = NULL, $title = '') {
static $stored_feed_links = array();
Gábor Hojtsy
committed
if (!is_null($url) && !isset($stored_feed_links[$url])) {
$stored_feed_links[$url] = theme('feed_icon', $url, $title);
drupal_add_link(array('rel' => 'alternate',
'type' => 'application/rss+xml',
'title' => $title,
'href' => $url));
}
return $stored_feed_links;
}
/**
* Get 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($feeds, $delimiter);
}
Gerhard Killesreiter
committed
/**
* Parse an array into a valid urlencoded query string.
*
* @param $query
* The array to be processed e.g. $_GET.
Gerhard Killesreiter
committed
* @param $exclude
* The array filled with keys to be excluded. Use parent[child] to exclude
* nested items.
Gerhard Killesreiter
committed
* @param $parent
* Should not be passed, only used in recursive calls.
Gerhard Killesreiter
committed
* @return
* An urlencoded string which can be appended to/as the URL query string.
Gerhard Killesreiter
committed
*/
function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
$params = array();
foreach ($query as $key => $value) {
Gerhard Killesreiter
committed
if ($parent) {
$key = $parent . '[' . $key . ']';
Gerhard Killesreiter
committed
}
if (in_array($key, $exclude)) {
Gerhard Killesreiter
committed
continue;
}
if (is_array($value)) {
$params[] = drupal_query_string_encode($value, $exclude, $key);
}
else {
$params[] = $key . '=' . drupal_urlencode($value);
Gerhard Killesreiter
committed
}
}
return implode('&', $params);
}
/**
* Prepare a destination query string for use in combination 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.
*
* @see drupal_goto()
*/
function drupal_get_destination() {
if (isset($_REQUEST['destination'])) {
return 'destination=' . urlencode($_REQUEST['destination']);
Dries Buytaert
committed
}
else {
// Use $_GET here to retrieve the original path in source form.
$path = isset($_GET['q']) ? $_GET['q'] : '';
Gerhard Killesreiter
committed
$query = drupal_query_string_encode($_GET, array('q'));
if ($query != '') {
$path .= '?' . $query;
Gerhard Killesreiter
committed
}
return 'destination=' . urlencode($path);
}
}
* 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
* a post on the 'admin/content/node'-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.
* This function ends the request; use it instead of a return in your menu callback.
* A Drupal path or a full URL.
* A query string component, if any.
* A destination fragment identifier (named anchor).
* @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
* - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
* Note: Other values are defined by RFC 2616, but are rarely used and poorly
* supported.
* @see drupal_get_destination()
function drupal_goto($path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) {
Dries Buytaert
committed
if (isset($_REQUEST['destination'])) {
extract(parse_url(urldecode($_REQUEST['destination'])));
}
$url = url($path, array('query' => $query, 'fragment' => $fragment, 'absolute' => TRUE));
// Remove newlines from the URL to avoid header injection attacks.
$url = str_replace(array("\n", "\r"), '', $url);
// Allow modules to react to the end of the page request before redirecting.
Dries Buytaert
committed
// We do not want this while running update.php.
if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
Dries Buytaert
committed
module_invoke_all('exit', $url);
}
Dries Buytaert
committed
if (drupal_session_is_started()) {
// Even though session_write_close() is registered as a shutdown function,
// we need all session data written to the database before redirecting.
session_write_close();
}
Dries Buytaert
committed
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
/**
Dries Buytaert
committed
* Generates a site offline message.
Dries Buytaert
committed
*/
function drupal_site_offline() {
drupal_maintenance_theme();
Dries Buytaert
committed
drupal_set_header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service unavailable');
Dries Buytaert
committed
drupal_set_title(t('Site offline'));
Steven Wittens
committed
print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal'))))));
Dries Buytaert
committed
}
/**
* Generates a 404 error if the request can not be handled.
*/
Dries Buytaert
committed
drupal_set_header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
watchdog('page not found', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
// Keep old path for reference.
if (!isset($_REQUEST['destination'])) {
$_REQUEST['destination'] = $_GET['q'];
}
// Custom 404 handler. Set the active item in case there are tabs to
// display, or other dependencies on the path.
Gábor Hojtsy
committed
menu_set_active_item($path);
Dries Buytaert
committed
$return = menu_execute_active_handler($path);
Gerhard Killesreiter
committed
}
Gábor Hojtsy
committed
if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
// Standard 404 handler.
Gábor Hojtsy
committed
$return = t('The requested page could not be found.');
$page = drupal_get_page($return);
// To conserve CPU and bandwidth, omit the blocks.
$page['#show_blocks'] = FALSE;
print drupal_render_page($page);
/**
* Generates a 403 error if the request is not allowed.
*/
function drupal_access_denied() {
Dries Buytaert
committed
drupal_set_header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
watchdog('access denied', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
// Keep old path for reference.
if (!isset($_REQUEST['destination'])) {
$_REQUEST['destination'] = $_GET['q'];
}
// Custom 403 handler. Set the active item in case there are tabs to
// display or other dependencies on the path.
Gábor Hojtsy
committed
menu_set_active_item($path);
Dries Buytaert
committed
$return = menu_execute_active_handler($path);
Gerhard Killesreiter
committed
}
Gábor Hojtsy
committed
if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
// Standard 403 handler.
drupal_set_title(t('Access denied'));
$return = t('You are not authorized to access this page.');
print drupal_render_page($return);
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 $options
* (optional) An array which can have one or more of following keys:
* - 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. Defaults to NULL.
* - max_redirects
* An integer representing how many times a redirect may be followed.
* Defaults to 3.
Dries Buytaert
committed
* An object which can have one or more of the following parameters:
* - 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.
* - 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.
* - headers
* An array containing the response headers as name/value pairs.
* - data
* A string containing the response body that was received.
Dries Buytaert
committed
function drupal_http_request($url, array $options = array()) {
Dries Buytaert
committed
global $db_prefix;
Dries Buytaert
committed
$result = new stdClass();
// Parse the URL and make sure we can handle the schema.
Dries Buytaert
committed
$uri = @parse_url($url);
Dries Buytaert
committed
Dries Buytaert
committed
if ($uri == FALSE) {
$result->error = 'unable to parse URL';
Dries Buytaert
committed
return $result;
}
Dries Buytaert
committed
if (!isset($uri['scheme'])) {
$result->error = 'missing schema';
Dries Buytaert
committed
return $result;
}
$port = isset($uri['port']) ? $uri['port'] : 80;
$host = $uri['host'] . ($port != 80 ? ':' . $port : '');
Dries Buytaert
committed
$fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries Buytaert
committed
// Note: Only works when PHP is compiled with OpenSSL support.
$port = isset($uri['port']) ? $uri['port'] : 443;
$host = $uri['host'] . ($port != 443 ? ':' . $port : '');
$fp = @fsockopen('ssl://' . $uri['host'], $port, $errno, $errstr, 20);
$result->error = 'invalid schema ' . $uri['scheme'];
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;
$result->error = trim($errstr);
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.
// @see system_requirements()
variable_set('drupal_http_request_fails', TRUE);
$path = isset($uri['path']) ? $uri['path'] : '/';
if (isset($uri['query'])) {
$path .= '?' . $uri['query'];
Dries Buytaert
committed
// Merge the default options.
$options += array(
'headers' => array(),
'method' => 'GET',
'data' => NULL,
'max_redirects' => 3,
);
// Merge the default headers.
$options['headers'] += array(
// RFC 2616: "non-standard ports MUST, default ports MAY be included".
// We don't add the port to prevent from breaking rewrite rules checking the
// host that do not take into account the port number.
Dries Buytaert
committed
'Host' => $host,
'User-Agent' => 'Drupal (+http://drupal.org/)',
'Content-Length' => strlen($options['data']),
// If the server url has a user then attempt to use basic authentication
if (isset($uri['user'])) {
Dries Buytaert
committed
$options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (!empty($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.
if (preg_match("/simpletest\d+/", $db_prefix, $matches)) {
Dries Buytaert
committed
$options['headers']['User-Agent'] = $matches[0];
Dries Buytaert
committed
}
Dries Buytaert
committed
foreach ($options['headers'] as $name => $value) {
$options['headers'][$name] = $name . ': ' . trim($value);
Dries Buytaert
committed
$request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
$request .= implode("\r\n", $options['headers']);
$request .= "\r\n\r\n" . $options['data'];
$result->request = $request;
fwrite($fp, $request);
// Fetch response.
Dries Buytaert
committed
while (!feof($fp) && $chunk = fread($fp, 1024)) {
$response .= $chunk;
Dries Buytaert
committed
// 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);
Dries Buytaert
committed
// Parse the response status line.
list($protocol, $code, $status) = explode(' ', trim(array_shift($response)), 3);
Dries Buytaert
committed
// Parse the response headers.
while ($line = trim(array_shift($response))) {
if (isset($result->headers[$header]) && $header == 'Set-Cookie') {
// RFC 2109: the Set-Cookie response header comprises the token Set-
// Cookie:, followed by a comma-separated list of one or more cookies.
$result->headers[$header] .= ',' . trim($value);
}
else {
$result->headers[$header] = trim($value);
}
Dries Buytaert
committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
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',
// RFC 2616 states that all unknown HTTP codes must be treated the same as the
// base code in their class.
if (!isset($responses[$code])) {
$code = floor($code / 100) * 100;
}
Dries Buytaert
committed
$result->code = $code;
switch ($code) {
case 200: // OK
case 304: // Not modified
break;
case 301: // Moved permanently
case 302: // Moved temporarily
case 307: // Moved temporarily
$location = $result->headers['Location'];
Dries Buytaert
committed
if ($options['max_redirects']) {
// Redirect to the new location.
$options['max_redirects']--;
$result = drupal_http_request($location, $options);
$result->redirect_code = $code;
Dries Buytaert
committed
$result->error = $status;
Dries Buytaert
committed
* Custom PHP error handler.
Dries Buytaert
committed
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
* @param $error_level
* The level of the error raised.
* @param $message
* The error message.
* @param $filename
* The filename that the error was raised in.
* @param $line
* The line number the error was raised at.
* @param $context
* An array that points to the active symbol table at the point the error occurred.
*/
function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
if ($error_level & error_reporting()) {
// All these constants are documented at http://php.net/manual/en/errorfunc.constants.php
$types = array(
E_ERROR => 'Error',
E_WARNING => 'Warning',
E_PARSE => 'Parse error',
E_NOTICE => 'Notice',
E_CORE_ERROR => 'Core error',
E_CORE_WARNING => 'Core warning',
E_COMPILE_ERROR => 'Compile error',
E_COMPILE_WARNING => 'Compile warning',
E_USER_ERROR => 'User error',
E_USER_WARNING => 'User warning',
E_USER_NOTICE => 'User notice',
E_STRICT => 'Strict warning',
E_RECOVERABLE_ERROR => 'Recoverable fatal error'
);
$backtrace = debug_backtrace();
Dries Buytaert
committed
Dries Buytaert
committed
$caller = _drupal_get_last_caller(debug_backtrace());
Dries Buytaert
committed
// We treat recoverable errors as fatal.
Dries Buytaert
committed
_drupal_log_error(array(
'%type' => isset($types[$error_level]) ? $types[$error_level] : 'Unknown error',
'%message' => $message,
'%function' => $caller['function'],
'%file' => $caller['file'],
'%line' => $caller['line'],
), $error_level == E_RECOVERABLE_ERROR);
Dries Buytaert
committed
}
}
/**
* Custom PHP exception handler.
*
* Uncaught exceptions are those not enclosed in a try/catch block. They are
* always fatal: the execution of the script will stop as soon as the exception
* handler exits.
*
* @param $exception
* The exception object that was thrown.
Dries Buytaert
committed
function _drupal_exception_handler($exception) {
Dries Buytaert
committed
// Log the message to the watchdog and return an error page to the user.
_drupal_log_error(_drupal_decode_exception($exception), TRUE);
}
/**
* Decode an exception, especially to retrive the correct caller.
*
* @param $exception
* The exception object that was thrown.
* @return An error in the format expected by _drupal_log_error().
*/
function _drupal_decode_exception($exception) {
Dries Buytaert
committed
$backtrace = $exception->getTrace();
// Add the line throwing the exception to the backtrace.
array_unshift($backtrace, array('line' => $exception->getLine(), 'file' => $exception->getFile()));
// For PDOException errors, we try to return the initial caller,
// skipping internal functions of the database layer.
if ($exception instanceof PDOException) {
// The first element in the stack is the call, the second element gives us the caller.
// We skip calls that occurred in one of the classes of the database layer
// or in one of its global functions.
$db_functions = array('db_query', 'pager_query', 'db_query_range', 'db_query_temporary', 'update_sql');
Dries Buytaert
committed
while (!empty($backtrace[1]) && ($caller = $backtrace[1]) &&
Dries Buytaert
committed
((isset($caller['class']) && (strpos($caller['class'], 'Query') !== FALSE || strpos($caller['class'], 'Database') !== FALSE)) ||
in_array($caller['function'], $db_functions))) {
// We remove that call.
array_shift($backtrace);
}
Neil Drumm
committed
}
Dries Buytaert
committed
$caller = _drupal_get_last_caller($backtrace);
Neil Drumm
committed
Dries Buytaert
committed
return array(
'%type' => get_class($exception),
'%message' => $exception->getMessage(),
'%function' => $caller['function'],
'%file' => $caller['file'],
'%line' => $caller['line'],
);
Dries Buytaert
committed
}
Gábor Hojtsy
committed
Dries Buytaert
committed
/**
* Log a PHP error or exception, display an error page in fatal cases.
*
Dries Buytaert
committed
* @param $error
* An array with the following keys: %type, %message, %function, %file, %line.
Dries Buytaert
committed
* @param $fatal
* TRUE if the error is fatal.
*/
Dries Buytaert
committed
function _drupal_log_error($error, $fatal = FALSE) {
Dries Buytaert
committed
// Initialize a maintenance theme early if the boostrap was not complete.
// Do it early because drupal_set_message() triggers an init_theme().
if ($fatal && (drupal_get_bootstrap_phase() != DRUPAL_BOOTSTRAP_FULL)) {
unset($GLOBALS['theme']);
Dries Buytaert
committed
if (!defined('MAINTENANCE_MODE')) {
define('MAINTENANCE_MODE', 'error');
}
Dries Buytaert
committed
drupal_maintenance_theme();
}
Gábor Hojtsy
committed
Dries Buytaert
committed
// When running inside the testing framework, we relay the errors
// to the tested site by the way of HTTP headers.
Dries Buytaert
committed
if (preg_match("/^simpletest\d+/", $_SERVER['HTTP_USER_AGENT']) && !headers_sent() && (!defined('SIMPLETEST_COLLECT_ERRORS') || SIMPLETEST_COLLECT_ERRORS)) {
Dries Buytaert
committed
static $number = 0;
$assertion = array(
Dries Buytaert
committed
$error['%message'],
$error['%type'],
Dries Buytaert
committed
array(
'function' => $error['%function'],
'file' => $error['%file'],
'line' => $error['%line'],
),
Dries Buytaert
committed
);
header('X-Drupal-Assertion-' . $number . ': ' . rawurlencode(serialize($assertion)));
$number++;
}
Dries Buytaert
committed
// Force display of error messages in update.php or if the proper error
// reporting level is set.
$error_level = variable_get('error_level', 2);
if ($error_level == 2 || ($error_level == 1 && $error['%type'] != 'Notice') || (defined('MAINTENANCE_MODE') && MAINTENANCE_MODE == 'update')) {
Dries Buytaert
committed
drupal_set_message(t('%type: %message in %function (line %line of %file).', $error), 'error');
Dries Buytaert
committed
}
Gábor Hojtsy
committed
Dries Buytaert
committed
try {
watchdog('php', '%type: %message in %function (line %line of %file).', $error, WATCHDOG_ERROR);
}
catch (Exception $e) {
$new_error = _drupal_decode_exception($e);
drupal_set_message(t('%type: %message in %function (line %line of %file).', $new_error), 'error');
}
Dries Buytaert
committed
if ($fatal) {
drupal_set_header($_SERVER['SERVER_PROTOCOL'] . ' Service unavailable');
drupal_set_title(t('Error'));
Dries Buytaert
committed
if (!defined('MAINTENANCE_MODE') && drupal_get_bootstrap_phase() == DRUPAL_BOOTSTRAP_FULL) {
// To conserve CPU and bandwidth, omit the blocks.
$page = drupal_get_page(t('The website encountered an unexpected error. Please try again later.'));
$page['#show_blocks'] = FALSE;
print drupal_render_page($page);
Dries Buytaert
committed
else {
print theme('maintenance_page', t('The website encountered an unexpected error. Please try again later.'), FALSE);
Dries Buytaert
committed
}
exit;
/**
Dries Buytaert
committed
* Gets the last caller from a backtrace.
*
* @param $backtrace
* A standard PHP backtrace.
* @return
* An associative array with keys 'file', 'line' and 'function'.
*/
function _drupal_get_last_caller($backtrace) {
Angie Byron
committed
// Errors that occur inside PHP internal functions
// do not generate information about file and line.
while ($backtrace && !isset($backtrace[0]['line'])) {
array_shift($backtrace);
}
// The first trace is the call itself.
// It gives us the line and the file of the last call.
$call = $backtrace[0];
// The second call give us the function where the call originated.
if (isset($backtrace[1])) {
if (isset($backtrace[1]['class'])) {
$call['function'] = $backtrace[1]['class'] . $backtrace[1]['type'] . $backtrace[1]['function'] . '()';
}
else {
$call['function'] = $backtrace[1]['function'] . '()';
}
}
else {
$call['function'] = 'main()';
}
return $call;
}
array_walk($item, '_fix_gpc_magic');
}
else {
Neil Drumm
committed
/**
* 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);
}
}
}
* Fix double-escaping problems caused by "magic quotes" in some PHP installations.
static $fixed = FALSE;
array_walk($_GET, '_fix_gpc_magic');
array_walk($_POST, '_fix_gpc_magic');
array_walk($_COOKIE, '_fix_gpc_magic');
array_walk($_REQUEST, '_fix_gpc_magic');
Neil Drumm
committed
array_walk($_FILES, '_fix_gpc_magic_files');
$fixed = TRUE;
Gábor Hojtsy
committed
* Translate strings to the page language or a given language.
* Human-readable text that will be displayed somewhere within a page should
* be run through the t() function.
*
* Examples:
* @code
* if (!$info || !$info['extension']) {
* form_set_error('picture_upload', t('The uploaded file was not an image.'));
* }
*
* $form['submit'] = array(
* '#type' => 'submit',
* '#value' => t('Log in'),
* );
* @endcode
*
* Any text within t() can be extracted by translators and changed into
* the equivalent text in their native language.
*
* Special variables called "placeholders" are used to signal dynamic
* information in a string which should not be translated. Placeholders
* can also be used for text that may change from time to time (such as
* link paths) to be changed without requiring updates to translations.
*
* For example:
* @code
* $output = t('There are currently %members and %visitors online.', array(
* '%members' => format_plural($total_users, '1 user', '@count users'),
* '%visitors' => format_plural($guests->count, '1 guest', '@count guests')));
* @endcode
*
* There are three styles of placeholders:
* - !variable, which indicates that the text should be inserted as-is. This is
* useful for inserting variables into things like e-mail.
* @code
* $message[] = t("If you don't want to receive such e-mails, you can change your settings at !url.", array('!url' => url("user/$account->uid", array('absolute' => TRUE))));
* - @variable, which indicates that the text should be run through
* check_plain, to escape HTML characters. Use this for any output that's
* displayed within a Drupal page.
Angie Byron
committed
* drupal_set_title($title = t("@name's blog", array('@name' => $account->name)), PASS_THROUGH);
Dries Buytaert
committed
* - %variable, which indicates that the string should be HTML escaped and
* highlighted with theme_placeholder() which shows up by default as
* <em>emphasized</em>.
* $message = t('%name-from sent %name-to an e-mail.', array('%name-from' => $user->name, '%name-to' => $account->name));
* When using t(), try to put entire sentences and strings in one t() call.
* This makes it easier for translators, as it provides context as to what
* each word refers to. HTML markup within translation strings is allowed, but
* should be avoided if possible. The exception are embedded links; link
* titles add a context for translators, so should be kept in the main string.
* Here is an example of incorrect usage of t():
* @code
* $output .= t('<p>Go to the @contact-page.</p>', array('@contact-page' => l(t('contact page'), 'contact')));
* @endcode
*
* Here is an example of t() used correctly:
* @code
* $output .= '<p>' . t('Go to the <a href="@contact-page">contact page</a>.', array('@contact-page' => url('contact'))) . '</p>';
* Avoid escaping quotation marks wherever possible.
*
* Incorrect:
* @code
* $output .= t('Don\'t click me.');
* @endcode
*
* Correct:
* $output .= t("Don't click me.");
* Because t() is designed for handling code-based strings, in almost all
* cases, the actual string and not a variable must be passed through t().
*
* Extraction of translations is done based on the strings contained in t()
* calls. If a variable is passed through t(), the content of the variable
* cannot be extracted from the file for translation.
*