/includes/common.inc
PHP | 4055 lines | 2800 code | 202 blank | 1053 comment | 263 complexity | 5da247440aaad8049545961f51562367 MD5 | raw file
Possible License(s): AGPL-1.0, BSD-3-Clause, GPL-2.0, AGPL-3.0, LGPL-2.1
Large files files are truncated, but you can click here to view the full file
- <?php
- /**
- * @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.
- */
- /**
- * 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);
- /**
- * Create E_DEPRECATED constant for older PHP versions (<5.3).
- */
- if (!defined('E_DEPRECATED')) {
- define('E_DEPRECATED', 8192);
- }
- /**
- * 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 imploded array elements.
- */
- function drupal_get_content($region = NULL, $delimiter = ' ') {
- $content = drupal_set_content();
- if (isset($region)) {
- if (isset($content[$region]) && is_array($content[$region])) {
- return implode($delimiter, $content[$region]);
- }
- }
- else {
- foreach (array_keys($content) as $region) {
- if (is_array($content[$region])) {
- $content[$region] = implode($delimiter, $content[$region]);
- }
- }
- return $content;
- }
- }
- /**
- * Set 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.
- */
- function drupal_set_breadcrumb($breadcrumb = NULL) {
- static $stored_breadcrumb;
- if (!is_null($breadcrumb)) {
- $stored_breadcrumb = $breadcrumb;
- }
- return $stored_breadcrumb;
- }
- /**
- * Get the breadcrumb trail for the current page.
- */
- function drupal_get_breadcrumb() {
- $breadcrumb = drupal_set_breadcrumb();
- if (is_null($breadcrumb)) {
- $breadcrumb = menu_get_active_breadcrumb();
- }
- return $breadcrumb;
- }
- /**
- * Add output to the head tag of the HTML page.
- *
- * This function can be called as long the headers aren't sent.
- */
- function drupal_set_html_head($data = NULL) {
- static $stored_head = '';
- if (!is_null($data)) {
- $stored_head .= $data ."\n";
- }
- return $stored_head;
- }
- /**
- * Retrieve output to be displayed in the head tag of the HTML page.
- */
- function drupal_get_html_head() {
- $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');
- }
- /*
- * The function drupal_set_header() has been moved to includes/bootstrap.inc in Pressflow.
- */
- /**
- * Get the HTTP response headers for the current page.
- *
- * This function is not called by Pressflow and remains here
- * only for Drupal 5/6 API compatibility.
- */
- function drupal_get_headers() {
- $headers = drupal_set_header();
- $header_text = array();
- foreach ($headers as $name => $value) {
- $header_text[] .= $name . ': ' . $value;
- }
- return implode("\n", $header_text);
- }
- /**
- * Make any final alterations to the rendered xhtml.
- */
- function drupal_final_markup($content) {
- // Make sure that the charset is always specified as the first element of the
- // head region to prevent encoding-based attacks.
- return preg_replace('/<head[^>]*>/i', "\$0\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />", $content, 1);
- }
- /**
- * Add a feed URL for the current page.
- *
- * @param $url
- * A url for the feed.
- * @param $title
- * The title of the feed.
- */
- function drupal_add_feed($url = NULL, $title = '') {
- static $stored_feed_links = array();
- 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);
- }
- /**
- * @defgroup http_handling HTTP handling
- * @{
- * Functions to properly handle HTTP responses.
- */
- /**
- * Parse an array into a valid urlencoded query string.
- *
- * @param $query
- * The array to be processed e.g. $_GET.
- * @param $exclude
- * The array filled with keys to be excluded. Use parent[child] to exclude
- * nested items.
- * @param $parent
- * Should not be passed, only used in recursive calls.
- * @return
- * An urlencoded string which can be appended to/as the URL query string.
- */
- function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
- $params = array();
- foreach ($query as $key => $value) {
- $key = rawurlencode($key);
- if ($parent) {
- $key = $parent .'['. $key .']';
- }
- if (in_array($key, $exclude)) {
- continue;
- }
- if (is_array($value)) {
- $params[] = drupal_query_string_encode($value, $exclude, $key);
- }
- else {
- $params[] = $key .'='. rawurlencode($value);
- }
- }
- 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']);
- }
- else {
- // Use $_GET here to retrieve the original path in source form.
- $path = isset($_GET['q']) ? $_GET['q'] : '';
- $query = drupal_query_string_encode($_GET, array('q'));
- if ($query != '') {
- $path .= '?'. $query;
- }
- return 'destination='. urlencode($path);
- }
- }
- /**
- * Send the user to a different Drupal 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) or the $_REQUEST['edit']-array (i.e. by
- * using a hidden form field). 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 rather than a print theme('page')
- * statement in your menu callback.
- *
- * @param $path
- * A Drupal path or a full URL.
- * @param $query
- * A query string component, if any.
- * @param $fragment
- * 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) {
- $destination = FALSE;
- if (isset($_REQUEST['destination'])) {
- $destination = $_REQUEST['destination'];
- }
- else if (isset($_REQUEST['edit']['destination'])) {
- $destination = $_REQUEST['edit']['destination'];
- }
- if ($destination) {
- // Do not redirect to an absolute URL originating from user input.
- $colonpos = strpos($destination, ':');
- $absolute = ($colonpos !== FALSE && !preg_match('![/?#]!', substr($destination, 0, $colonpos)));
- if (!$absolute) {
- extract(parse_url(urldecode($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.
- // We do not want this while running update.php.
- if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
- module_invoke_all('exit', $url);
- }
- // Even though session_write_close() is registered as a shutdown function,
- // we need all session data written to the database before redirecting.
- drupal_session_commit();
- header('Location: '. $url, TRUE, $http_response_code);
- // 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.
- exit();
- }
- /**
- * Generates a site off-line message.
- */
- function drupal_site_offline() {
- drupal_maintenance_theme();
- drupal_set_header('HTTP/1.1 503 Service unavailable');
- drupal_set_title(t('Site off-line'));
- 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', 'Pressflow'))))));
- }
- /**
- * Generates a 404 error if the request can not be handled.
- */
- function drupal_not_found() {
- drupal_set_header('HTTP/1.1 404 Not Found');
- watchdog('page not found', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
- // Keep old path for reference, and to allow forms to redirect to it.
- if (!isset($_REQUEST['destination'])) {
- $_REQUEST['destination'] = $_GET['q'];
- }
- $path = drupal_get_normal_path(variable_get('site_404', ''));
- if ($path && $path != $_GET['q']) {
- // Set the active item in case there are tabs to display, or other
- // dependencies on the path.
- menu_set_active_item($path);
- $return = menu_execute_active_handler($path);
- }
- if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
- drupal_set_title(t('Page not found'));
- $return = t('The requested page could not be found.');
- }
- // To conserve CPU and bandwidth, omit the blocks.
- print theme('page', $return, FALSE);
- }
- /**
- * Generates a 403 error if the request is not allowed.
- */
- function drupal_access_denied() {
- drupal_set_header('HTTP/1.1 403 Forbidden');
- watchdog('access denied', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
- // Keep old path for reference, and to allow forms to redirect to it.
- if (!isset($_REQUEST['destination'])) {
- $_REQUEST['destination'] = $_GET['q'];
- }
- $path = drupal_get_normal_path(variable_get('site_403', ''));
- if ($path && $path != $_GET['q']) {
- // Set the active item in case there are tabs to display or other
- // dependencies on the path.
- menu_set_active_item($path);
- $return = menu_execute_active_handler($path);
- }
- if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
- drupal_set_title(t('Access denied'));
- $return = t('You are not authorized to access this page.');
- }
- print theme('page', $return);
- }
- /**
- * Perform an HTTP request.
- *
- * This is a flexible and powerful HTTP client implementation. Correctly handles
- * GET, POST, PUT or any other HTTP requests. Handles redirects.
- *
- * @param $url
- * A string containing a fully qualified URI.
- * @param $headers
- * An array containing an HTTP header => value pair.
- * @param $method
- * A string defining the HTTP request to use.
- * @param $data
- * A string containing data to include in the request.
- * @param $retry
- * An integer representing how many times to retry the request in case of a
- * redirect.
- * @return
- * An object containing the HTTP request headers, response code, protocol,
- * status message, headers, data and redirect status.
- */
- function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
- global $db_prefix;
- $result = new stdClass();
- // Parse the URL and make sure we can handle the schema.
- $uri = parse_url($url);
- if ($uri == FALSE) {
- $result->error = 'unable to parse URL';
- $result->code = -1001;
- return $result;
- }
- if (!isset($uri['scheme'])) {
- $result->error = 'missing schema';
- $result->code = -1002;
- return $result;
- }
- switch ($uri['scheme']) {
- case 'http':
- case 'feed':
- $port = isset($uri['port']) ? $uri['port'] : 80;
- $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
- $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
- break;
- case 'https':
- // Note: Only works for PHP 4.3 compiled with OpenSSL.
- $port = isset($uri['port']) ? $uri['port'] : 443;
- $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
- $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
- break;
- default:
- $result->error = 'invalid schema '. $uri['scheme'];
- $result->code = -1003;
- return $result;
- }
- // Make sure the socket opened properly.
- if (!$fp) {
- // When a network error occurs, we use a negative number so it does not
- // clash with the HTTP status codes.
- $result->code = -$errno;
- $result->error = trim($errstr);
- // 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);
- return $result;
- }
- // Construct the path to act on.
- $path = isset($uri['path']) ? $uri['path'] : '/';
- if (isset($uri['query'])) {
- $path .= '?'. $uri['query'];
- }
- // Create HTTP request.
- $defaults = 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.
- 'Host' => "Host: $host",
- 'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
- );
- // 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.
- $content_length = strlen($data);
- if ($content_length > 0 || $method == 'POST' || $method == 'PUT') {
- $defaults['Content-Length'] = 'Content-Length: '. $content_length;
- }
- // If the server url has a user then attempt to use basic authentication
- if (isset($uri['user'])) {
- $defaults['Authorization'] = 'Authorization: Basic '. base64_encode($uri['user'] . (!empty($uri['pass']) ? ":". $uri['pass'] : ''));
- }
- // 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 (is_string($db_prefix) && preg_match("/^simpletest\d+$/", $db_prefix, $matches)) {
- $defaults['User-Agent'] = 'User-Agent: ' . drupal_generate_test_ua($matches[0]);
- }
- foreach ($headers as $header => $value) {
- $defaults[$header] = $header .': '. $value;
- }
- $request = $method .' '. $path ." HTTP/1.0\r\n";
- $request .= implode("\r\n", $defaults);
- $request .= "\r\n\r\n";
- $request .= $data;
- $result->request = $request;
- fwrite($fp, $request);
- // Fetch response.
- $response = '';
- while (!feof($fp) && $chunk = fread($fp, 1024)) {
- $response .= $chunk;
- }
- fclose($fp);
- // Parse response.
- list($split, $result->data) = explode("\r\n\r\n", $response, 2);
- $split = preg_split("/\r\n|\n|\r/", $split);
- list($protocol, $code, $status_message) = explode(' ', trim(array_shift($split)), 3);
- $result->protocol = $protocol;
- $result->status_message = $status_message;
- $result->headers = array();
- // Parse headers.
- while ($line = trim(array_shift($split))) {
- list($header, $value) = explode(':', $line, 2);
- 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);
- }
- }
- $responses = array(
- 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;
- }
- 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'];
- if ($retry) {
- $result = drupal_http_request($result->headers['Location'], $headers, $method, $data, --$retry);
- $result->redirect_code = $result->code;
- }
- $result->redirect_url = $location;
- break;
- default:
- $result->error = $status_message;
- }
- $result->code = $code;
- return $result;
- }
- /**
- * @} End of "HTTP handling".
- */
- /**
- * Log errors as defined by administrator.
- *
- * Error levels:
- * - 0 = Log errors to database.
- * - 1 = Log errors to database and to screen.
- */
- function drupal_error_handler($errno, $message, $filename, $line, $context) {
- // If the @ error suppression operator was used, error_reporting will have
- // been temporarily set to 0.
- if (error_reporting() == 0) {
- return;
- }
- if ($errno & (E_ALL ^ E_DEPRECATED ^ E_NOTICE)) {
- $types = array(1 => 'error', 2 => 'warning', 4 => 'parse error', 8 => 'notice', 16 => 'core error', 32 => 'core warning', 64 => 'compile error', 128 => 'compile warning', 256 => 'user error', 512 => 'user warning', 1024 => 'user notice', 2048 => 'strict warning', 4096 => 'recoverable fatal error');
- // For database errors, we want the line number/file name of the place that
- // the query was originally called, not _db_query().
- if (isset($context[DB_ERROR])) {
- $backtrace = array_reverse(debug_backtrace());
- // List of functions where SQL queries can originate.
- $query_functions = array('db_query', 'pager_query', 'db_query_range', 'db_query_temporary', 'update_sql');
- // Determine where query function was called, and adjust line/file
- // accordingly.
- foreach ($backtrace as $index => $function) {
- if (in_array($function['function'], $query_functions)) {
- $line = $backtrace[$index]['line'];
- $filename = $backtrace[$index]['file'];
- break;
- }
- }
- }
- $entry = check_plain($types[$errno]) .': '. filter_xss($message) .' in '. check_plain($filename) .' on line '. check_plain($line) .'.';
- // Force display of error messages in update.php.
- if (variable_get('error_level', 1) == 1 || strstr($_SERVER['SCRIPT_NAME'], 'update.php')) {
- drupal_set_message($entry, 'error');
- }
- watchdog('php', '%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line), WATCHDOG_ERROR);
- }
- }
- function _fix_gpc_magic(&$item) {
- if (is_array($item)) {
- array_walk($item, '_fix_gpc_magic');
- }
- else {
- $item = stripslashes($item);
- }
- }
- /**
- * 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.
- */
- function fix_gpc_magic() {
- static $fixed = FALSE;
- if (!$fixed && ini_get('magic_quotes_gpc')) {
- array_walk($_GET, '_fix_gpc_magic');
- array_walk($_POST, '_fix_gpc_magic');
- array_walk($_COOKIE, '_fix_gpc_magic');
- array_walk($_REQUEST, '_fix_gpc_magic');
- array_walk($_FILES, '_fix_gpc_magic_files');
- $fixed = TRUE;
- }
- }
- /**
- * 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))));
- * @endcode
- *
- * - @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.
- * @code
- * drupal_set_title($title = t("@name's blog", array('@name' => $account->name)));
- * @endcode
- *
- * - %variable, which indicates that the string should be HTML escaped and
- * highlighted with theme_placeholder() which shows up by default as
- * <em>emphasized</em>.
- * @code
- * $message = t('%name-from sent %name-to an e-mail.', array('%name-from' => $user->name, '%name-to' => $account->name));
- * @endcode
- *
- * 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>';
- * @endcode
- *
- * Avoid escaping quotation marks wherever possible.
- *
- * Incorrect:
- * @code
- * $output .= t('Don\'t click me.');
- * @endcode
- *
- * Correct:
- * @code
- * $output .= t("Don't click me.");
- * @endcode
- *
- * 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.
- *
- * Incorrect:
- * @code
- * $message = 'An error occurred.';
- * drupal_set_message(t($message), 'error');
- * $output .= t($message);
- * @endcode
- *
- * Correct:
- * @code
- * $message = t('An error occurred.');
- * drupal_set_message($message, 'error');
- * $output .= $message;
- * @endcode
- *
- * The only case in which variables can be passed safely through t() is when
- * code-based versions of the same strings will be passed through t() (or
- * otherwise extracted) elsewhere.
- *
- * In some cases, modules may include strings in code that can't use t()
- * calls. For example, a module may use an external PHP application that
- * produces strings that are loaded into variables in Drupal for output.
- * In these cases, module authors may include a dummy file that passes the
- * relevant strings through t(). This approach will allow the strings to be
- * extracted.
- *
- * Sample external (non-Drupal) code:
- * @code
- * class Time {
- * public $yesterday = 'Yesterday';
- * public $today = 'Today';
- * public $tomorrow = 'Tomorrow';
- * }
- * @endcode
- *
- * Sample dummy file.
- * @code
- * // Dummy function included in example.potx.inc.
- * function example_potx() {
- * $strings = array(
- * t('Yesterday'),
- * t('Today'),
- * t('Tomorrow'),
- * );
- * // No return value needed, since this is a dummy function.
- * }
- * @endcode
- *
- * Having passed strings through t() in a dummy function, it is then
- * okay to pass variables through t().
- *
- * Correct (if a dummy file was used):
- * @code
- * $time = new Time();
- * $output .= t($time->today);
- * @endcode
- *
- * However tempting it is, custom data from user input or other non-code
- * sources should not be passed through t(). Doing so leads to the following
- * problems and errors:
- * - The t() system doesn't support updates to existing strings. When user
- * data is updated, the next time it's passed through t() a new record is
- * created instead of an update. The database bloats over time and any
- * existing translations are orphaned with each update.
- * - The t() system assumes any data it receives is in English. User data may
- * be in another language, producing translation errors.
- * - The "Built-in interface" text group in the locale system is used to
- * produce translations for storage in .po files. When non-code strings are
- * passed through t(), they are added to this text group, which is rendered
- * inaccurate since it is a mix of actual interface strings and various user
- * input strings of uncertain origin.
- *
- * Incorrect:
- * @code
- * $item = item_load();
- * $output .= check_plain(t($item['title']));
- * @endcode
- *
- * Instead, translation of these data can be done through the locale system,
- * either directly or through helper functions provided by contributed
- * modules.
- * @see hook_locale()
- *
- * During installation, st() is used in place of t(). Code that may be called
- * during installation or during normal operation should use the get_t()
- * helper function.
- * @see st()
- * @see get_t()
- *
- * @param $string
- * A string containing the English string to translate.
- * @param $args
- * An associative array of replacements to make after translation. Incidences
- * of any key in this array are replaced with the corresponding value. Based
- * on the first character of the key, the value is escaped and/or themed:
- * - !variable: inserted as is
- * - @variable: escape plain text to HTML (check_plain)
- * - %variable: escape text and theme as a placeholder for user-submitted
- * content (check_plain + theme_placeholder)
- * @param $langcode
- * Optional language code to translate to a language other than what is used
- * to display the page.
- * @return
- * The translated string.
- */
- function t($string, $args = array(), $langcode = NULL) {
- global $language;
- static $custom_strings;
- $langcode = isset($langcode) ? $langcode : $language->language;
- // First, check for an array of customized strings. If present, use the array
- // *instead of* database lookups. This is a high performance way to provide a
- // handful of string replacements. See settings.php for examples.
- // Cache the $custom_strings variable to improve performance.
- if (!isset($custom_strings[$langcode])) {
- $custom_strings[$langcode] = variable_get('locale_custom_strings_'. $langcode, array());
- }
- // Custom strings work for English too, even if locale module is disabled.
- if (isset($custom_strings[$langcode][$string])) {
- $string = $custom_strings[$langcode][$string];
- }
- // Translate with locale module if enabled.
- elseif (function_exists('locale') && $langcode != 'en') {
- $string = locale($string, $langcode);
- }
- if (empty($args)) {
- return $string;
- }
- else {
- // Transform arguments before inserting them.
- foreach ($args as $key => $value) {
- switch ($key[0]) {
- case '@':
- // Escaped only.
- $args[$key] = check_plain($value);
- break;
- case '%':
- default:
- // Escaped and placeholder.
- $args[$key] = theme('placeholder', $value);
- break;
- case '!':
- // Pass-through.
- }
- }
- return strtr($string, $args);
- }
- }
- /**
- * @defgroup validation Input validation
- * @{
- * Functions to validate user input.
- */
- /**
- * Verifies the syntax of the given e-mail address.
- *
- * See RFC 2822 for details.
- *
- * @param $mail
- * A string containing an e-mail address.
- * @return
- * 1 if the email address is valid, 0 if it is invalid or empty, and FALSE if
- * there is an input error (such as passing in an array instead of a string).
- */
- function valid_email_address($mail) {
- $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
- $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
- $ipv4 = '[0-9]{1,3}(\.[0-9]{1,3}){3}';
- $ipv6 = '[0-9a-fA-F]{1,4}(\:[0-9a-fA-F]{1,4}){7}';
- return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
- }
- /**
- * Verify the syntax of the given URL.
- *
- * This function should only be used on actual URLs. It should not be used for
- * Drupal menu paths, which can contain arbitrary characters.
- * Valid values per RFC 3986.
- *
- * @param $url
- * The URL to verify.
- * @param $absolute
- * Whether the URL is absolute (beginning with a scheme such as "http:").
- * @return
- * TRUE if the URL is in a valid format.
- */
- function valid_url($url, $absolute = FALSE) {
- if ($absolute) {
- return (bool)preg_match("
- /^ # Start at the beginning of the text
- (?:ftp|https?|feed):\/\/ # Look for ftp, http, https or feed schemes
- (?: # Userinfo (optional) which is typically
- (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)* # a username or a username and password
- (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@ # combination
- )?
- (?:
- (?:[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)
- (?:[\/|\?]
- (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2}) # The path and query (optional)
- *)?
- $/xi", $url);
- }
- else {
- return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
- }
- }
- /**
- * @} End of "defgroup validation".
- */
- /**
- * Register an event for the current visitor (hostname/IP) to the flood control mechanism.
- *
- * @param $name
- * The name of an event.
- */
- function flood_register_event($name) {
- db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, ip_address(), time());
- }
- /**
- * Check if the current visitor (hostname/IP) is allowed to proceed with the specified event.
- *
- * The user is allowed to proceed if he did not trigger the specified event more
- * than $threshold times per hour.
- *
- * @param $name
- * The name of the event.
- * @param $threshold
- * The maximum number of the specified event per hour (per visitor).
- * @return
- * True if the user did not exceed the hourly threshold. False otherwise.
- */
- function flood_is_allowed($name, $threshold) {
- $number = db_result(db_query("SELECT COUNT(*) FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, ip_address(), time() - 3600));
- return ($number < $threshold ? TRUE : FALSE);
- }
- function check_file($filename) {
- return is_uploaded_file($filename);
- }
- /**
- * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
- */
- function check_url($uri) {
- return filter_xss_bad_protocol($uri, FALSE);
- }
- /**
- * @defgroup format Formatting
- * @{
- * Functions to format numbers, strings, dates, etc.
- */
- /**
- * Formats an RSS channel.
- *
- * Arbitrary elements may be added using the $args associative array.
- */
- function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
- global $language;
- $langcode = $langcode ? $langcode : $language->language;
- $output = "<channel>\n";
- $output .= ' <title>'. check_plain($title) ."</title>\n";
- $output .= ' <link>'. check_url($link) ."</link>\n";
- // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
- // We strip all HTML tags, but need to prevent double encoding from properly
- // escaped source data (such as & becoming &amp;).
- $output .= ' <description>'. check_plain(decode_entities(strip_tags($description))) ."</description>\n";
- $output .= ' <language>'. check_plain($langcode) ."</language>\n";
- $output .= format_xml_elements($args);
- $output .= $items;
- $output .= "</channel>\n";
- return $output;
- }
- /**
- * Format a single RSS item.
- *
- * Arbitrary elements may be added using the $args associative array.
- */
- function format_rss_item($title, $link, $description, $args = array()) {
- $output = "<item>\n";
- $output .= ' <title>'. check_plain($title) ."</title>\n";
- $output .= ' <link>'. check_url($link) ."</link>\n";
- $output .= ' <description>'. check_plain($description) ."</description>\n";
- $output .= format_xml_elements($args);
- $output .= "</item>\n";
- return $output;
- }
- /**
- * Format XML elements.
- *
- * @param $array
- * An array where each item represent an element and is either a:
- * - (key => value) pair (<key>value</key>)
- * - Associative array with fields:
- * - 'key': element name
- * - 'value': element contents
- * - 'attributes': associative array of element attributes
- *
- * In both cases, 'value' can be a simple string, or it can be another array
- * with the same format as $array itself for nesting.
- */
- function format_xml_elements($array) {
- $output = '';
- foreach ($array as $key => $value) {
- if (is_numeric($key)) {
- if ($value['key']) {
- $output .= ' <'. $value['key'];
- if (isset($value['attributes']) && is_array($value['attributes'])) {
- $output .= drupal_attributes($value['attributes']);
- }
- if (isset($value['value']) && $value['value'] != '') {
- $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
- }
- else {
- $output .= " />\n";
- }
- }
- }
- else {
- $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
- }
- }
- return $output;
- }
- /**
- * Format a string containing a count of items.
- *
- * This function ensures that the string is pluralized correctly. Since t() is
- * called by this function, make sure not to pass already-localized strings to
- * it.
- *
- * For example:
- * @code
- * $output = format_plural($node->comment_count, '1 comment', '@count comments');
- * @endcode
- *
- * Example with additional replacements:
- * @code
- * $output = format_plural($update_count,
- * 'Changed the content type of 1 post from %old-type to %new-type.',
- * 'Changed the content type of @count posts from %old-type to %new-type.',
- * array('%old-type' => $info->old_type, '%new-type' => $info->new_type)));
- * @endcode
- *
- * @param $count
- * The item count to display.
- * @param $singular
- * The string for the singular case. Please make sure it is clear this is
- * singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
- * Do not use @count in the singular string.
- * @param $plural
- * The string for the plural case. Please make sure it is clear this is plural,
- * to ease translation. Use @count in place of the item count, as in "@count
- * new comments".
- * @param $args
- * An associative array of replacements to make after translation. Incidences
- * of any key in this array are replaced with the corresponding value.
- * Based on the first character of the key, the value is escaped and/or themed:
- * - !variable: inserted as is
- * - @variable: escape plain text to HTML (check_plain)
- * - %variable: escape text and theme as a placeholder for user-submitted
- * content (check_plain + theme_placeholder)
- * Note that you do not need to include @count in this array.
- * This replacement is done automatically for the plural case.
- * @param $langcode
- * Optional language code to translate to a language other than
- * what is used to display the page.
- * @return
- * A translated string.
- */
- function format_plural($count, $singular, $plural, $args = array(), $langcode = NULL) {
- $args['@count'] = $count;
- if ($count == 1) {
- return t($singular, $args, $langcode);
- }
- // Get the plural index through the gettext formula.
- $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, $langcode) : -1;
- // Backwards compatibility.
- if ($index < 0) {
- return t($plural, $args, $langcode);
- }
- else {
- switch ($index) {
- case "0":
- return t($singular, $args, $langcode);
- case "1":
- return t($plural, $args, $langcode);
- default:
- unset($args['@count']);
- $args['@count['. $index .']'] = $count;
- return t(strtr($plural, array('@count' => '@count['. $index .']')), $args, $langcode);
- }
- }
- }
- /**
- * Parse a given byte count.
- *
- * @param $size
- * A size expressed as a number of bytes with optional SI size and unit
- * suffix (e.g. 2, 3K, 5MB, 10G).
- * @return
- * An integer representation of the size.
- */
- function parse_size($size) {
- $suffixes = array(
- '' => 1,
- 'k' => 1024,
- 'm' => 1048576, // 1024 * 1024
- 'g' => 1073741824, // 1024 * 1024 * 1024
- );
- if (preg_match('/([0-9]+)\s*(k|m|g)?(b?(ytes?)?)/i', $size, $match)) {
- return $match[1] * $suffixes[drupal_strtolower($match[2])];
- }
- }
- /**
- * Generate a string representation for the given byte count.
- *
- * @param $size
- * A size in bytes.
- * @param $langcode
- * Optional language code to translate to a language other than what is used
- * to display the page.
- * @return
- * A translated string representation of the size.
- */
- function format_size($size, $langcode = NULL) {
- if ($size < 1024) {
- return format_plural($size, '1 byte', '@count bytes', array(), $langcode);
- }
- else {
- $size = round($size / 1024, 2);
- $suffix = t('KB', array(), $langcode);
- if ($size >= 1024) {
- $size = round($size / 1024, 2);
- $suffix = t('MB', array(), $langcode);
- }
- return t('@size @suffix', array('@size' => $size, '@suffix' => $suffix), $langcode);
- }
- }
- /**
- * Format a time interval with the requested granularity.
- *
- * @param $timestamp
- * The length of the interval in seconds.
- * @param $granularity
- * How many different units to display in the string.
- * @param $langcode
- * Optional language code to translate to a language other than
- * what is used to display the page.
- * @return
- * A translated string representation of the interval.
- */
- function format_interval($timestamp, $granularity = 2, $langcode = NULL) {
- $units = array('1 year|@count years' => 31536000, '1 week|@count weeks' => 604800, '1 day|@count days' => 86400, '1 hour|@count hours' => 3600, '1 min|@count min' => 60, '1 sec|@count sec' => 1);
- $output = '';
- foreach ($units as $key => $value) {
- $key = explode('|', $key);
- if ($timestamp >= $value) {
- $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1], array(), $langcode);
- $timestamp %= $value;
- $granularity--;
- }
- if ($granularity == 0) {
- break;
- }
- }
- return $output ? $output : t('0 sec', array(), $langcode);
- }
- /**
- * Format a date with the given configured format or a custom format string.
- *
- * Drupal allows administrators to select formatting strings for 'small',
- * 'medium' and 'large' date formats. This function can handle these formats,
- * as well as any custom format.
- *
- * @param $timestamp
- * The exact date to format, as a UNIX timestamp.
- * @param $type
- * The format to use. Can be "small", "medium" or "large" for the preconfigured
- * date formats. If "custom" is specified, then $format is required as well.
- * @param $format
- * A PHP date format string as required by date(). A backslash should be used
- * before a character to avoid interpreting the character as part of a date
- * format.
- * @param $timezone
- * Time zone offset in seconds; if omitted, the user's time zone is used.
- * @param $langcode
- * Optional language code to translate to a language other than what is used
- * to display the page.
- * @return
- * A translated date string in the requested format.
- */
- function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
- if (!isset($timezone)) {
- global $user;
- if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
- $timezone = $user->timezone;
- }
- else {
- $timezone = variable_get('date_default_timezone', 0);
- }
- }
- $timestamp += $timezone;
- switch ($type) {
- case 'small':
- $format = variable_get('date_format_short', 'm/d/Y - H:i');
- break;
- case 'large':
- $format = variable_get('date_format_long', 'l, F j, Y - H:i');
- break;
- case 'custom':
- // No change to format.
- break;
- case 'medium':
- default:
- $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
- }
- $max = strlen($format);
- $date = '';
- for ($i = 0; $i < $max; $i++) {
- $c = $format[$i];
- if (strpos('AaDlM', $c) !== FALSE) {
- $date .= t(gmdate($c, $timestamp), array(), $langcode);
- }
- else if ($c == 'F') {
- // Special treatment for long month names: May is both an abbreviation
- // and a full month name in English, but other languages have
- // different abbreviations.
- $date .= trim(t('!long-month-name '. gmdate($c, $timestamp), array('!long-month-name' => ''), $langcode));
- }
- else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== FALSE) {
- $date .= gmdate($c, $timestamp);
- }
- else if ($c == 'r') {
- $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone, $langcode);
- }
- else if ($c == 'O') {
- $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
- }
- else if ($c == 'Z') {
- $date .= $timezone;
- }
- else if ($c == '\\') {
- $date .= $format[++$i];
- }
- else {
- $date .= $c;
- }
- }
- return $date;
- }
- /**
- * @} End of "defgroup format".
- */
- /**
- * Generates an internal or external URL.
- *
- * When creating links in modules, consider whether l() could be a better
- * alternative than url().
- *
- * @param $path
- * The internal path or external URL being linked to, such as "node/34" or
- * "http://example.com/foo". A few notes:
- * - If you provide a full URL, it will be considered an external URL.
- * - If you provide only the path (e.g. "node/34"), it will be
- * considered an internal link. In this case, it should be a system URL,
- * and it will be replaced with the alias, if one exists. Additional query
- * arguments for internal paths must be supplied in $options['query'], not
- * included in $path.
- * - If you provide an internal path and $options['alias'] is set to TRUE, the
- * path is assumed already to be the correct path alias, and the alias is
- * not looked up.
- * - The special string '<front>' generates a link to the site's base URL.
- * - If your external URL contains a query (e.g. http://example.com/foo?a=b),
- * then you can either URL encode the query keys and values yourself and
- * include them in $path, or use $options['query'] to let this function
- * URL encode them.
- * @param $options
- * An associative array of additional options, with the following elements:
- * - 'query': A URL-encoded query string to append to the link, or an array of
- * query key/value-pairs without any URL-encoding.
- * - 'fragment': A fragment identifier (named anchor) to append to the URL.
- * Do not include the leading '#' character.
- * - 'absolute' (default FALSE): Whether to force the output to be an absolute
- * link (beginning with http:). Useful for links that will be displayed
- * outside the site, such as in an RSS feed.
- * - 'alias' (default FALSE): Whether the given path is a URL alias already.
- * - 'external': Whether the given path is an external URL.
- * - 'language': An optional language object. Used to build the URL to link
- * to and look up the proper alias for the link.
- * - 'base_url': Only used internally, to modify the base URL when a language
- * dependent URL requires so.
- * - 'prefix': Only used internally, to modify the path when a language
- * dependent URL requires so.
- *
- * @return
- * A string containing a URL to the given path.
- */
- function url($path = NULL, $options = array()) {
- // Merge in defaults.
- $options += array(
- 'fragment' => '',
- 'query' => '',
- 'absolute' => FALSE,
- 'alias' => FALSE,
- 'prefix' => ''
- );
- if (!isset($options['external'])) {
- // Return an external link if $path contains an allowed absolute URL.
- // Only call the slow filter_xss_bad_protocol if $path contains a ':' before
- // any / ? or #.
- $colonpos = strpos($path, ':');
- $options['external'] = ($colonpos !== FALSE && !preg_match('![/?#]!', substr($path, 0, $colonpos)) && filter_xss_bad_protocol($path, FALSE) == check_plain($path));
- }
- // May need language dependent rewriting if language.inc is present.
- if (function_exists('language_url_rewrite')) {
- language_url_rewrite($path, $options);
- }
- if ($options['fragment']) {
- $options['fragment'] = '#'. $options['fragment'];
- }
- if (is_array($options['query'])) {
- $options['query'] = drupal_query_string_encode($options['query']);
- }
- if ($options['external']) {
- // Split off the fragment.
- if (strpos($path, '#') !== FALSE) {
- list($path, $old_fragment) = explode('#', $path, 2);
- if (isset($old_fragment) && !$options['fragment']) {
- $options['fragment'] = '#'. $old_fragment;
- }
- }
- // Append the query.
- if ($options['query']) {
- $path .= (strpos($path, '?') !== FALSE ? '&' : '?') . $options['query'];
- }
- // Reassemble.
- return $path . $options['fragment'];
- }
- global $base_url;
- static $script;
- if (!isset($script)) {
- // On some web servers, such as IIS, we can't omit "index.php". So, we
- // generate "index.php?q=foo" instead of "?q=foo" on anything that is not
- // Apache.
- $script = (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') === FALSE) ? 'index.php' …
Large files files are truncated, but you can click here to view the full file