Newer
Older
/**
* @file
* Functions that need to be loaded on every Drupal request.
*/
Alex Pott
committed
use Drupal\Component\Datetime\DateTimePlus;
Angie Byron
committed
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Utility\Environment;
use Drupal\Component\Utility\SafeMarkup;
Alex Pott
committed
use Drupal\Component\Utility\String;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\DrupalKernel;
catch
committed
use Drupal\Core\Extension\ExtensionDiscovery;
Alex Pott
committed
use Drupal\Core\Site\Settings;
catch
committed
use Drupal\Core\Utility\Error;
catch
committed
use Symfony\Component\ClassLoader\ApcClassLoader;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Drupal\Core\Language\LanguageInterface;
Dries Buytaert
committed
/**
* Minimum supported version of PHP.
*/
Dries Buytaert
committed
const DRUPAL_MINIMUM_PHP = '5.4.2';
Dries Buytaert
committed
/**
* Minimum recommended value of PHP memory_limit.
*
* @todo Reduce the memory required to install on some environments in
* https://www.drupal.org/node/2289201 and then decrease this limit.
Dries Buytaert
committed
*/
const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '64M';
Dries Buytaert
committed
Angie Byron
committed
/**
* Error reporting level: display no errors.
*/
const ERROR_REPORTING_HIDE = 'hide';
/**
* Error reporting level: display errors and warnings.
*/
const ERROR_REPORTING_DISPLAY_SOME = 'some';
/**
* Error reporting level: display all messages.
*/
const ERROR_REPORTING_DISPLAY_ALL = 'all';
/**
* Error reporting level: display all messages, plus backtrace information.
*/
const ERROR_REPORTING_DISPLAY_VERBOSE = 'verbose';
Angie Byron
committed
/**
* @defgroup logging_severity_levels Logging severity levels
* @{
* Logging severity levels as defined in RFC 3164.
*
* The WATCHDOG_* constant definitions correspond to the logging severity levels
catch
committed
* defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
Angie Byron
committed
* for use in the syslog() function, but their values on Windows builds do not
catch
committed
* correspond to RFC 3164. The associated PHP bug report was closed with the
Angie Byron
committed
* comment, "And it's also not a bug, as Windows just have less log levels,"
* and "So the behavior you're seeing is perfectly normal."
*
* @see http://www.faqs.org/rfcs/rfc3164.html
* @see http://bugs.php.net/bug.php?id=18090
* @see http://php.net/manual/function.syslog.php
* @see http://php.net/manual/network.constants.php
* @see watchdog()
* @see watchdog_severity_levels()
*/
/**
* Log message severity -- Emergency: system is unusable.
*/
const WATCHDOG_EMERGENCY = 0;
Angie Byron
committed
/**
* Log message severity -- Alert: action must be taken immediately.
*/
const WATCHDOG_ALERT = 1;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Critical conditions.
Angie Byron
committed
*/
const WATCHDOG_CRITICAL = 2;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Error conditions.
Angie Byron
committed
*/
const WATCHDOG_ERROR = 3;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Warning conditions.
Angie Byron
committed
*/
const WATCHDOG_WARNING = 4;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Normal but significant conditions.
Angie Byron
committed
*/
const WATCHDOG_NOTICE = 5;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Informational messages.
Angie Byron
committed
*/
const WATCHDOG_INFO = 6;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Debug-level messages.
Angie Byron
committed
*/
const WATCHDOG_DEBUG = 7;
Angie Byron
committed
/**
* @} End of "defgroup logging_severity_levels".
*/
/**
* First bootstrap phase: initialize configuration.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
* Second bootstrap phase, initialize a kernel.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
const DRUPAL_BOOTSTRAP_KERNEL = 1;
* Third bootstrap phase: try to serve a cached page.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
* Fourth bootstrap phase: load code for subsystems and modules.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
const DRUPAL_BOOTSTRAP_CODE = 3;
* Final bootstrap phase: initialize language, path, theme, and modules.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
const DRUPAL_BOOTSTRAP_FULL = 4;
/**
* Role ID for anonymous users; should match what's in the "role" table.
*/
catch
committed
const DRUPAL_ANONYMOUS_RID = 'anonymous';
/**
* Role ID for authenticated users; should match what's in the "role" table.
*/
catch
committed
const DRUPAL_AUTHENTICATED_RID = 'authenticated';
Dries Buytaert
committed
/**
* The maximum number of characters in a module or theme name.
*/
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Time of the current request in seconds elapsed since the Unix Epoch.
Dries Buytaert
committed
*
Dries Buytaert
committed
* This differs from $_SERVER['REQUEST_TIME'], which is stored as a float
* since PHP 5.4.0. Float timestamps confuse most PHP functions
* (including date_create()).
*
* @see http://php.net/manual/reserved.variables.server.php
* @see http://php.net/manual/function.time.php
Dries Buytaert
committed
*/
Dries Buytaert
committed
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
Dries Buytaert
committed
Dries Buytaert
committed
/**
* Regular expression to match PHP function names.
*
* @see http://php.net/manual/language.functions.php
Dries Buytaert
committed
*/
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
Dries Buytaert
committed
Angie Byron
committed
/**
* $config_directories key for active directory.
*
Jennifer Hodgdon
committed
* @see config_get_config_directory()
Angie Byron
committed
*/
const CONFIG_ACTIVE_DIRECTORY = 'active';
/**
* $config_directories key for staging directory.
*
Jennifer Hodgdon
committed
* @see config_get_config_directory()
Angie Byron
committed
*/
const CONFIG_STAGING_DIRECTORY = 'staging';
Angie Byron
committed
/**
* Defines the root directory of the Drupal installation.
*
* This strips two levels of directories off the current directory.
*/
define('DRUPAL_ROOT', dirname(dirname(__DIR__)));
Jennifer Hodgdon
committed
* Returns the appropriate configuration directory.
* @param bool $require_settings
* Only configuration directories with an existing settings.php file
* will be recognized. Defaults to TRUE. During initial installation,
* this is set to FALSE so that Drupal can detect a matching directory,
* then create a new settings.php file in it.
* @param bool $reset
* Force a full search for matching directories even if one had been
* found previously. Defaults to FALSE.
* @param \Symfony\Component\HttpFoundation\Request $request
* (optional) The current request. Defaults to \Drupal::request() or a new
* request created from globals.
* @return string
* The path of the matching directory.@see default.settings.php
Jennifer Hodgdon
committed
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Drupal\Core\DrupalKernel::getSitePath() instead. If the kernel is
* unavailable or the site path needs to be recalculated then
* Drupal\Core\DrupalKernel::findSitePath() can be used.
*/
function conf_path($require_settings = TRUE, $reset = FALSE, Request $request = NULL) {
if (!isset($request)) {
if (\Drupal::hasRequest()) {
$request = \Drupal::request();
}
// @todo Remove once external CLI scripts (Drush) are updated.
else {
$request = Request::createFromGlobals();
}
}
if (\Drupal::hasService('kernel')) {
$site_path = \Drupal::service('kernel')->getSitePath();
Angie Byron
committed
}
if (!isset($site_path) || empty($site_path)) {
$site_path = DrupalKernel::findSitePath($request, $require_settings);
return $site_path;
/**
Angie Byron
committed
* Returns the path of a configuration directory.
*
* @param string $type
* (optional) The type of config directory to return. Drupal core provides
* 'active' and 'staging'. Defaults to CONFIG_ACTIVE_DIRECTORY.
*
* @return string
* The configuration directory path.
*/
Angie Byron
committed
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
global $config_directories;
Angie Byron
committed
if (!empty($config_directories[$type])) {
catch
committed
return $config_directories[$type];
}
Angie Byron
committed
throw new \Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
}
catch
committed
* Returns and optionally sets the filename for a system resource.
*
* The filename, whether provided, cached, or retrieved from the database, is
* only returned if the file exists.
* This function plays a key role in allowing Drupal's resources (modules
* and themes) to be located in different places depending on a site's
Jennifer Hodgdon
committed
* configuration. For example, a module 'foo' may legally be located
* core/modules/foo/foo.info.yml
* modules/foo/foo.info.yml
* sites/example.com/modules/foo/foo.info.yml
*
* Calling drupal_get_filename('module', 'foo') will give you one of
* the above, depending on where the module is located.
*
* The type of the item; one of 'core', 'profile', 'module', 'theme', or
* 'theme_engine'.
* The name of the item for which the filename is requested. Ignored for
* $type 'core'.
* @param $filename
* The filename of the item if it is to be set explicitly rather
* than by consulting the database.
*
* @return
Jennifer Hodgdon
committed
* The filename of the requested item or NULL if the item is not found.
function drupal_get_filename($type, $name, $filename = NULL) {
// The location of files will not change during the request, so do not use
// drupal_static().
catch
committed
static $files = array();
// Type 'core' only exists to simplify application-level logic; it always maps
// to the /core directory, whereas $name is ignored. It is only requested via
// drupal_get_path(). /core/core.info.yml does not exist, but is required
// since drupal_get_path() returns the dirname() of the returned pathname.
if ($type === 'core') {
return 'core/core.info.yml';
}
// Profiles are converted into modules in system_rebuild_module_data().
// @todo Remove false-exposure of profiles as modules.
$original_type = $type;
if ($type == 'profile') {
$type = 'module';
if (!isset($files[$type])) {
catch
committed
if (isset($filename)) {
catch
committed
elseif (!isset($files[$type][$name])) {
// If the pathname of the requested extension is not known, try to retrieve
// the list of extension pathnames from various providers, checking faster
// providers first.
// Retrieve the current module list (derived from the service container).
if ($type == 'module' && \Drupal::hasService('module_handler')) {
foreach (\Drupal::moduleHandler()->getModuleList() as $module_name => $module) {
$files[$type][$module_name] = $module->getPathname();
}
catch
committed
}
// If still unknown, retrieve the file list prepared in state by
// system_rebuild_module_data() and system_rebuild_theme_data().
if (!isset($files[$type][$name]) && \Drupal::hasService('state')) {
$files[$type] += \Drupal::state()->get('system.' . $type . '.files', array());
Angie Byron
committed
}
catch
committed
// If still unknown, perform a filesystem scan.
Angie Byron
committed
if (!isset($files[$type][$name])) {
catch
committed
$listing = new ExtensionDiscovery();
// Prevent an infinite recursion by this legacy function.
if ($original_type == 'profile') {
$listing->setProfileDirectories(array());
Angie Byron
committed
}
catch
committed
foreach ($listing->scan($original_type) as $extension_name => $file) {
$files[$type][$extension_name] = $file->getPathname();
Steven Wittens
committed
if (isset($files[$type][$name])) {
return $files[$type][$name];
}
/**
* Gets the page cache cid for this request.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request for this page.
*
* @return string
* The cid for this request.
*/
function drupal_page_cache_get_cid(Request $request) {
$cid_parts = array(
$request->getUri(),
\Drupal::service('content_negotiation')->getContentType($request),
);
return sha1(implode(':', $cid_parts));
}
catch
committed
* Retrieves the current page from the cache.
* @param \Symfony\Component\HttpFoundation\Request $request
* The request for this page.
Dries Buytaert
committed
*
* @return \Symfony\Component\HttpFoundation\Response
* The response, if the page was found in the cache, NULL otherwise.
function drupal_page_get_cache(Request $request) {
$cache = \Drupal::cache('render')->get(drupal_page_cache_get_cid($request));
if ($cache) {
return $cache->data;
Dries Buytaert
committed
}
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
catch
committed
* Sets an HTTP response header for the current page.
Dries Buytaert
committed
*
* 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).
*
* @param $name
Dries Buytaert
committed
* The HTTP header name, or the special 'Status' header name.
Dries Buytaert
committed
* @param $value
Dries Buytaert
committed
* The HTTP header value; if equal to FALSE, the specified header is unset.
* If $name is 'Status', this is expected to be a status code followed by a
* reason phrase, e.g. "404 Not Found".
Dries Buytaert
committed
* @param $append
* Whether to append the value to an existing header or to replace it.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Symfony\Component\HttpFoundation\Response->headers->set().
* See https://drupal.org/node/2181523.
Dries Buytaert
committed
*/
Dries Buytaert
committed
function drupal_add_http_header($name, $value, $append = FALSE) {
Dries Buytaert
committed
// The headers as name/value pairs.
Dries Buytaert
committed
$headers = &drupal_static('drupal_http_headers', array());
Dries Buytaert
committed
Dries Buytaert
committed
$name_lower = strtolower($name);
Dries Buytaert
committed
_drupal_set_preferred_header_name($name);
Dries Buytaert
committed
Dries Buytaert
committed
if ($value === FALSE) {
Dries Buytaert
committed
$headers[$name_lower] = FALSE;
Dries Buytaert
committed
}
Dries Buytaert
committed
elseif (isset($headers[$name_lower]) && $append) {
Dries Buytaert
committed
// Multiple headers with identical names may be combined using comma (RFC
// 2616, section 4.2).
Dries Buytaert
committed
$headers[$name_lower] .= ',' . $value;
Dries Buytaert
committed
}
else {
Dries Buytaert
committed
$headers[$name_lower] = $value;
Dries Buytaert
committed
}
}
/**
catch
committed
* Gets the HTTP response headers for the current page.
Dries Buytaert
committed
*
* @param $name
* An HTTP header name. If omitted, all headers are returned as name/value
* pairs. If an array value is FALSE, the header has been unset.
catch
committed
*
Dries Buytaert
committed
* @return
* A string containing the header value, or FALSE if the header has been set,
* or NULL if the header has not been set.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Symfony\Component\HttpFoundation\Response->headers->get().
* See https://drupal.org/node/2181523.
Dries Buytaert
committed
*/
Dries Buytaert
committed
function drupal_get_http_header($name = NULL) {
Dries Buytaert
committed
$headers = &drupal_static('drupal_http_headers', array());
Dries Buytaert
committed
if (isset($name)) {
$name = strtolower($name);
return isset($headers[$name]) ? $headers[$name] : NULL;
}
else {
return $headers;
}
}
/**
catch
committed
* Sets the preferred name for the HTTP header.
*
Dries Buytaert
committed
* Header names are case-insensitive, but for maximum compatibility they should
* follow "common form" (see RFC 2616, section 4.2).
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* See https://drupal.org/node/2181523.
Dries Buytaert
committed
*/
function _drupal_set_preferred_header_name($name = NULL) {
static $header_names = array();
if (!isset($name)) {
return $header_names;
}
$header_names[strtolower($name)] = $name;
}
/**
catch
committed
* Sends the HTTP response headers that were previously set, adding defaults.
*
* Headers are set in drupal_add_http_header(). Default headers are not set
* if they have been replaced or unset using drupal_add_http_header().
Dries Buytaert
committed
*
* @param array $default_headers
* (optional) An array of headers as name/value pairs.
* @param bool $only_default
* (optional) If TRUE and headers have already been sent, send only the
* specified headers.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* See https://drupal.org/node/2181523.
Dries Buytaert
committed
*/
function drupal_send_headers($default_headers = array(), $only_default = FALSE) {
$headers_sent = &drupal_static(__FUNCTION__, FALSE);
Dries Buytaert
committed
$headers = drupal_get_http_header();
Dries Buytaert
committed
if ($only_default && $headers_sent) {
$headers = array();
}
$headers_sent = TRUE;
$header_names = _drupal_set_preferred_header_name();
foreach ($default_headers as $name => $value) {
$name_lower = strtolower($name);
if (!isset($headers[$name_lower])) {
$headers[$name_lower] = $value;
$header_names[$name_lower] = $name;
}
}
foreach ($headers as $name_lower => $value) {
Dries Buytaert
committed
if ($name_lower == 'status') {
Dries Buytaert
committed
header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
}
// Skip headers that have been unset.
Dries Buytaert
committed
elseif ($value !== FALSE) {
Dries Buytaert
committed
header($header_names[$name_lower] . ': ' . $value);
}
}
}
catch
committed
* Sets HTTP headers in preparation for a page response.
Dries Buytaert
committed
* Authenticated users are always given a 'no-cache' header, and will fetch a
* fresh page on every request. This prevents authenticated users from seeing
* locally cached pages.
*
* Also give each page a unique ETag. This should force clients to include both
Dries Buytaert
committed
* an If-Modified-Since header and an If-None-Match header when doing
* conditional requests for the page (required by RFC 2616, section 13.3.4),
* making the validation more robust. This is a workaround for a bug in Mozilla
* Firefox that is triggered when Drupal's caching is enabled and the user
* accesses Drupal via an HTTP proxy (see
* https://bugzilla.mozilla.org/show_bug.cgi?id=269303): When an authenticated
* user requests a page, and then logs out and requests the same page again,
* Firefox may send a conditional request based on the page that was cached
* locally when the user was logged in. If this page did not have an ETag
* header, the request only contains an If-Modified-Since header. The date will
* be recent, because with authenticated users the Last-Modified header always
* refers to the time of the request. If the user accesses Drupal via a proxy
* server, and the proxy already has a cached copy of the anonymous page with an
* older Last-Modified date, the proxy may respond with 304 Not Modified, making
* the client think that the anonymous and authenticated pageviews are
* identical.
Dries Buytaert
committed
*
Dries Buytaert
committed
* @see drupal_page_set_cache()
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* See https://drupal.org/node/2181523.
Dries Buytaert
committed
$headers_sent = &drupal_static(__FUNCTION__, FALSE);
if ($headers_sent) {
return TRUE;
}
$headers_sent = TRUE;
$default_headers = array(
'Expires' => 'Sun, 19 Nov 1978 05:00:00 GMT',
Alex Pott
committed
'Last-Modified' => gmdate(DateTimePlus::RFC7231, REQUEST_TIME),
Dries Buytaert
committed
'Cache-Control' => 'no-cache, must-revalidate, post-check=0, pre-check=0',
'ETag' => '"' . REQUEST_TIME . '"',
);
drupal_send_headers($default_headers);
/**
catch
committed
* Sets HTTP headers in preparation for a cached page response.
Dries Buytaert
committed
* The headers allow as much as possible in proxies and browsers without any
* particular knowledge about the pages. Modules can override these headers
Dries Buytaert
committed
* using drupal_add_http_header().
Dries Buytaert
committed
* If the request is conditional (using If-Modified-Since and If-None-Match),
* and the conditions match those currently in the cache, a 304 Not Modified
* response is sent.
*/
function drupal_serve_page_from_cache(Response $response, Request $request) {
// Only allow caching in the browser and prevent that the response is stored
// by an external proxy server when the following conditions apply:
// 1. There is a session cookie on the request.
// 2. The Vary: Cookie header is on the response.
// 3. The Cache-Control header does not contain the no-cache directive.
if ($request->cookies->has(session_name()) &&
in_array('Cookie', $response->getVary()) &&
!$response->headers->hasCacheControlDirective('no-cache')) {
$response->setPrivate();
Dries Buytaert
committed
}
// Negotiate whether to use compression.
if ($response->headers->get('Content-Encoding') == 'gzip' && extension_loaded('zlib')) {
if (strpos($request->headers->get('Accept-Encoding'), 'gzip') !== FALSE) {
// The response content is already gzip'ed, so make sure
Dries Buytaert
committed
// zlib.output_compression does not compress it once more.
Angie Byron
committed
ini_set('zlib.output_compression', '0');
Dries Buytaert
committed
}
else {
// The client does not support compression. Decompress the content and
// remove the Content-Encoding header.
$content = $response->getContent();
$content = gzinflate(substr(substr($content, 10), 0, -8));
$response->setContent($content);
$response->headers->remove('Content-Encoding');
Dries Buytaert
committed
}
}
// Perform HTTP revalidation.
// @todo Use Response::isNotModified() as per https://drupal.org/node/2259489
$last_modified = $response->getLastModified();
if ($last_modified) {
// See if the client has provided the required HTTP headers.
$if_modified_since = $request->server->has('HTTP_IF_MODIFIED_SINCE') ? strtotime($request->server->get('HTTP_IF_MODIFIED_SINCE')) : FALSE;
$if_none_match = $request->server->has('HTTP_IF_NONE_MATCH') ? stripslashes($request->server->get('HTTP_IF_NONE_MATCH')) : FALSE;
if ($if_modified_since && $if_none_match
&& $if_none_match == $response->getEtag() // etag must match
&& $if_modified_since == $last_modified->getTimestamp()) { // if-modified-since must match
$response->setStatusCode(304);
$response->setContent(NULL);
// In the case of a 304 response, certain headers must be sent, and the
// remaining may not (see RFC 2616, section 10.3.5).
foreach (array_keys($response->headers->all()) as $name) {
if (!in_array($name, array('content-location', 'expires', 'cache-control', 'vary'))) {
$response->headers->remove($name);
}
}
}
}
Angie Byron
committed
/**
Angie Byron
committed
* Translates a string to the current language or to a given language.
Angie Byron
committed
*
* The t() function serves two purposes. First, at run-time it translates
* user-visible text into the appropriate language. Second, various mechanisms
* that figure out what text needs to be translated work off t() -- the text
Dries Buytaert
committed
* inside t() calls is added to the database of strings to be translated.
* These strings are expected to be in English, so the first argument should
* always be in English. To enable a fully-translatable site, it is important
* that all human-readable text that will be displayed on the site or sent to
* a user is passed through the t() function, or a related function. See the
* @link http://drupal.org/node/322729 Localization API @endlink pages for
* more information, including recommendations on how to break up or not
* break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* You should never use t() to translate variables, such as calling
* @code t($text); @endcode, unless the text that the variable holds has been
* passed through t() elsewhere (e.g., $text is one of several translated
* literal strings in an array). It is especially important never to call
* @code t($user_text); @endcode, where $user_text is some text that a user
* entered - doing that can lead to cross-site scripting and other security
* problems. However, you can use variable substitution in your string, to put
* variable text such as user names or link URLs into translated text. Variable
* substitution looks like this:
Angie Byron
committed
* @code
* $text = t("@name's blog", array('@name' => user_format_name($account)));
Angie Byron
committed
* @endcode
* Basically, you can put variables like @name into your string, and t() will
* substitute their sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
Jennifer Hodgdon
committed
* format_string() for details about how to define variables in your string.)
* Translators can then rearrange the string as necessary for the language
* (e.g., in Spanish, it might be "blog de @name").
Angie Byron
committed
*
* @param $string
* A string containing the English string to translate.
* @param $args
* An associative array of replacements to make after translation. Based
* on the first character of the key, the value is escaped and/or themed.
* See format_string() for details.
Angie Byron
committed
* @param $options
* An associative array of additional options, with the following elements:
* - 'langcode' (defaults to the current language): The language code to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source string
* belongs to.
Angie Byron
committed
*
Angie Byron
committed
* @return
* The translated string.
Dries Buytaert
committed
*
* @see format_string()
Dries Buytaert
committed
* @ingroup sanitization
Angie Byron
committed
*/
function t($string, array $args = array(), array $options = array()) {
return \Drupal::translation()->translate($string, $args, $options);
Dries Buytaert
committed
}
/**
Angie Byron
committed
* Formats a string for HTML display by replacing variable placeholders.
*
Alex Pott
committed
* @see \Drupal\Component\Utility\String::format()
Dries Buytaert
committed
* @see t()
* @ingroup sanitization
*/
function format_string($string, array $args = array()) {
Alex Pott
committed
return String::format($string, $args);
Angie Byron
committed
}
/**
* Checks whether a string is valid UTF-8.
*
* All functions designed to filter input should use drupal_validate_utf8
* to ensure they operate on valid UTF-8 strings to prevent bypass of the
* filter.
*
* When text containing an invalid UTF-8 lead byte (0xC0 - 0xFF) is presented
* as UTF-8 to Internet Explorer 6, the program may misinterpret subsequent
* bytes. When these subsequent bytes are HTML control characters such as
* quotes or angle brackets, parts of the text that were deemed safe by filters
* end up in locations that are potentially unsafe; An onerror attribute that
* is outside of a tag, and thus deemed safe by a filter, can be interpreted
* by the browser as if it were inside the tag.
*
Dries Buytaert
committed
* The function does not return FALSE for strings containing character codes
* above U+10FFFF, even though these are prohibited by RFC 3629.
catch
committed
*
* @return
* TRUE if the text is valid UTF-8, FALSE if not.
*
* @see \Drupal\Component\Utility\Unicode::validateUtf8()
return Unicode::validateUtf8($text);
Dries Buytaert
committed
* Returns the equivalent of Apache's $_SERVER['REQUEST_URI'] variable.
*
* Because $_SERVER['REQUEST_URI'] is only available on Apache, we generate an
* equivalent using other environment variables.
Dries Buytaert
committed
*
* @todo The above comment is incorrect: http://drupal.org/node/1547294.
Dries Buytaert
committed
function request_uri($omit_query_string = FALSE) {
if (isset($_SERVER['REQUEST_URI'])) {
$uri = $_SERVER['REQUEST_URI'];
}
else {
Dries Buytaert
committed
if (isset($_SERVER['argv'][0])) {
$uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
elseif (isset($_SERVER['QUERY_STRING'])) {
$uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
else {
$uri = $_SERVER['SCRIPT_NAME'];
}
// Prevent multiple slashes to avoid cross site requests via the Form API.
$uri = '/' . ltrim($uri, '/');
Dries Buytaert
committed
Dries Buytaert
committed
return $omit_query_string ? strtok($uri, '?') : $uri;
Dries Buytaert
committed
/**
catch
committed
* Logs an exception.
Dries Buytaert
committed
*
* This is a wrapper function for watchdog() which automatically decodes an
* exception.
*
* @param $type
* The category to which this message belongs.
* @param $exception
* The exception that is going to be logged.
* @param $message
* The message to store in the log. If empty, a text that contains all useful
Dries Buytaert
committed
* information about the passed-in exception is used.
Dries Buytaert
committed
* @param $variables
catch
committed
* Array of variables to replace in the message on display or
* NULL if message is already translated or not possible to
* translate.
Dries Buytaert
committed
* @param $severity
* The severity of the message, as per RFC 3164.
* @param $link
* A link to associate with the message.
*
* @see watchdog()
catch
committed
* @see \Drupal\Core\Utility\Error::decodeException()
Dries Buytaert
committed
*/
Angie Byron
committed
function watchdog_exception($type, Exception $exception, $message = NULL, $variables = array(), $severity = WATCHDOG_ERROR, $link = NULL) {
Dries Buytaert
committed
Angie Byron
committed
// Use a default value if $message is not set.
if (empty($message)) {
// The exception message is run through
// \Drupal\Component\Utility\String::checkPlain() by
// \Drupal\Core\Utility\Error:decodeException().
$message = '%type: !message in %function (line %line of %file).';
}
if ($link) {
$variables['link'] = $link;
}
$variables += Error::decodeException($exception);
\Drupal::logger($type)->log($severity, $message, $variables);
Dries Buytaert
committed
}
catch
committed
* Logs a system message.
* The category to which this message belongs. Can be any string, but the
* general practice is to use the name of the module calling watchdog().
Dries Buytaert
committed
* The message to store in the log. Keep $message translatable
* by not concatenating dynamic values into it! Variables in the
* message should be added by using placeholder strings alongside
* the variables argument to declare the value of the placeholders.
* See t() for documentation on how $message and $variables interact.
* @param $variables
* Array of variables to replace in the message on display or array() if
* message is already translated or not possible to translate.
* @param $severity
Jennifer Hodgdon
committed
* The severity of the message; one of the following values as defined in
* @link http://www.faqs.org/rfcs/rfc3164.html RFC 3164: @endlink
* - WATCHDOG_EMERGENCY: Emergency, system is unusable.
* - WATCHDOG_ALERT: Alert, action must be taken immediately.
* - WATCHDOG_CRITICAL: Critical conditions.
* - WATCHDOG_ERROR: Error conditions.
* - WATCHDOG_WARNING: Warning conditions.
* - WATCHDOG_NOTICE: (default) Normal but significant conditions.
* - WATCHDOG_INFO: Informational messages.
* - WATCHDOG_DEBUG: Debug-level messages.
Dries Buytaert
committed
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Drupal::logger($channel)->log($severity, $message, $context), or any
* of the shortcut methods of \Psr\Log\LoggerTrait.
*
Gábor Hojtsy
committed
* @see watchdog_severity_levels()
Dries Buytaert
committed
* @see hook_watchdog()
function watchdog($type, $message, array $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
if ($link) {
$variables['link'] = $link;
Gerhard Killesreiter
committed
}
\Drupal::service('logger.factory')->get($type)->log($severity, $message, $variables);
Jennifer Hodgdon
committed
* Sets a message to display to the user.
* Messages are stored in a session variable and displayed in the page template
* via the $messages theme variable.
Jennifer Hodgdon
committed
* Example usage:
* @code
* drupal_set_message(t('An error occurred and processing did not complete.'), 'error');
* @endcode
*
* @param string $message
* (optional) The translated message to be displayed to the user. For
* consistency with other messages, it should begin with a capital letter and
* end with a period.
* @param string $type
* (optional) The message's type. Defaults to 'status'. These values are
* supported:
* - 'status'
* - 'error'
Jennifer Hodgdon
committed
* @param bool $repeat
* (optional) If this is FALSE and the message is already set, then the
Dries Buytaert
committed
* message won't be repeated. Defaults to FALSE.
Jennifer Hodgdon
committed
*
* @return array|null
* A multidimensional array with keys corresponding to the set message types.
* The indexed array values of each contain the set messages for that type,
* and each message is an associative array with the following format:
* - safe: Boolean indicating whether the message string has been marked as
* safe. Non-safe strings will be escaped automatically.
* - message: The message string.
* So, the following is an example of the full return array structure:
* @code
* array(
* 'status' => array(
* array(
* 'safe' => TRUE,
* 'message' => 'A <em>safe</em> markup string.',
* ),
* array(
* 'safe' => FALSE,
* 'message' => "$arbitrary_user_input to escape.",
* ),
* ),
* );
* @endcode
* If there are no messages set, the function returns NULL.
Jennifer Hodgdon
committed
*
* @see drupal_get_messages()
* @see theme_status_messages()
Dries Buytaert
committed
function drupal_set_message($message = NULL, $type = 'status', $repeat = FALSE) {
Dries Buytaert
committed
if ($message) {
if (!isset($_SESSION['messages'][$type])) {
$_SESSION['messages'][$type] = array();
}
Gábor Hojtsy
committed
if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
$_SESSION['messages'][$type][] = array(
'safe' => SafeMarkup::isSafe($message),
'message' => $message,
);
Gábor Hojtsy
committed
}
Dries Buytaert
committed
// Mark this page as being uncacheable.
Alex Pott
committed
\Drupal::service('page_cache_kill_switch')->trigger();
Steven Wittens
committed
}
// Messages not set when DB connection fails.
return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
Steven Wittens
committed
}
Jennifer Hodgdon
committed
* Returns all messages that have been set with drupal_set_message().
Jennifer Hodgdon
committed
* @param string $type
* (optional) Limit the messages returned by type. Defaults to NULL, meaning
* all types. These values are supported:
* - NULL
* - 'status'
* - 'warning'
* - 'error'
* @param bool $clear_queue
* (optional) If this is TRUE, the queue will be cleared of messages of the
* type specified in the $type parameter. Otherwise the queue will be left
* intact. Defaults to TRUE.
catch
committed
*
Jennifer Hodgdon
committed
* @return array
* An associative, nested array of messages grouped by message type, with
* the top-level keys as the message type. The messages returned are
* limited to the type specified in the $type parameter, if any. If there
* are no messages of the specified type, an empty array is returned. See
* drupal_set_message() for the array structure of individual messages.
Jennifer Hodgdon
committed
*
* @see drupal_set_message()
* @see theme_status_messages()
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
if ($messages = drupal_set_message()) {
foreach ($messages as $message_type => $message_typed_messages) {
foreach ($message_typed_messages as $key => $message) {
if ($message['safe']) {
$message['message'] = SafeMarkup::set($message['message']);
}
$messages[$message_type][$key] = $message['message'];
}
}
Dries Buytaert
committed
if ($type) {
if ($clear_queue) {
Gábor Hojtsy
committed
unset($_SESSION['messages'][$type]);
Dries Buytaert
committed
if (isset($messages[$type])) {
return array($type => $messages[$type]);
}
Dries Buytaert
committed
}
else {
if ($clear_queue) {
Gábor Hojtsy
committed
unset($_SESSION['messages']);
Dries Buytaert
committed
return $messages;
}
Dries Buytaert
committed
return array();
Steven Wittens
committed
}
/**
* Ensures Drupal is bootstrapped to the specified phase.
*
* In order to bootstrap Drupal from another PHP script, you can use this code:
* @code
* require_once '/path/to/drupal/core/vendor/autoload.php';
* require_once '/path/to/drupal/core/includes/bootstrap.inc';
* drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
* @endcode
*
* @param $phase
* A constant telling which phase to bootstrap to. Possible values:
Jennifer Hodgdon
committed
* - DRUPAL_BOOTSTRAP_CONFIGURATION: Initializes configuration.
* - DRUPAL_BOOTSTRAP_KERNEL: Initializes a kernel.
catch
committed
*
* @return int
Dries Buytaert
committed
* The most recently completed phase.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Interact directly with the kernel.
function drupal_bootstrap($phase = NULL) {
// Temporary variables used for booting later legacy phases.
/** @var \Drupal\Core\DrupalKernel $kernel */
static $kernel;
static $boot_level = 0;
Dries Buytaert
committed
if (isset($phase)) {
$request = Request::createFromGlobals();
for ($current_phase = $boot_level; $current_phase <= $phase; $current_phase++) {