5 * Functions that need to be loaded on every Drupal request.
8 use Drupal\Component\Utility\Crypt;
9 use Drupal\Component\Utility\Html;
10 use Drupal\Component\Utility\SafeMarkup;
11 use Drupal\Component\Utility\Unicode;
12 use Drupal\Core\Config\BootstrapConfigStorageFactory;
13 use Drupal\Core\Logger\RfcLogLevel;
14 use Drupal\Core\Render\Markup;
15 use Drupal\Component\Render\MarkupInterface;
16 use Drupal\Core\Test\TestDatabase;
17 use Drupal\Core\Session\AccountInterface;
18 use Drupal\Core\Site\Settings;
19 use Drupal\Core\Utility\Error;
20 use Drupal\Core\StringTranslation\TranslatableMarkup;
23 * Minimum supported version of PHP.
25 const DRUPAL_MINIMUM_PHP = '5.5.9';
28 * Minimum recommended value of PHP memory_limit.
30 * 64M was chosen as a minimum requirement in order to allow for additional
31 * contributed modules to be installed prior to hitting the limit. However,
32 * 40M is the target for the Standard installation profile.
34 const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '64M';
37 * Error reporting level: display no errors.
39 const ERROR_REPORTING_HIDE = 'hide';
42 * Error reporting level: display errors and warnings.
44 const ERROR_REPORTING_DISPLAY_SOME = 'some';
47 * Error reporting level: display all messages.
49 const ERROR_REPORTING_DISPLAY_ALL = 'all';
52 * Error reporting level: display all messages, plus backtrace information.
54 const ERROR_REPORTING_DISPLAY_VERBOSE = 'verbose';
57 * Role ID for anonymous users; should match what's in the "role" table.
59 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
60 * Use Drupal\Core\Session\AccountInterface::ANONYMOUS_ROLE or
61 * \Drupal\user\RoleInterface::ANONYMOUS_ID instead.
63 * @see https://www.drupal.org/node/1619504
65 const DRUPAL_ANONYMOUS_RID = AccountInterface::ANONYMOUS_ROLE;
68 * Role ID for authenticated users; should match what's in the "role" table.
70 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
71 * Use Drupal\Core\Session\AccountInterface::AUTHENTICATED_ROLE or
72 * \Drupal\user\RoleInterface::AUTHENTICATED_ID instead.
74 * @see https://www.drupal.org/node/1619504
76 const DRUPAL_AUTHENTICATED_RID = AccountInterface::AUTHENTICATED_ROLE;
79 * The maximum number of characters in a module or theme name.
81 const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;
84 * Time of the current request in seconds elapsed since the Unix Epoch.
86 * This differs from $_SERVER['REQUEST_TIME'], which is stored as a float
87 * since PHP 5.4.0. Float timestamps confuse most PHP functions
88 * (including date_create()).
90 * @see http://php.net/manual/reserved.variables.server.php
91 * @see http://php.net/manual/function.time.php
93 * @deprecated in Drupal 8.3.0, will be removed before Drupal 9.0.0.
94 * Use \Drupal::time()->getRequestTime();
96 * @see https://www.drupal.org/node/2785211
98 define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
101 * Regular expression to match PHP function names.
103 * @see http://php.net/manual/language.functions.php
105 const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
108 * $config_directories key for active directory.
110 * @see config_get_config_directory()
112 * @deprecated in Drupal 8.0.x and will be removed before 9.0.0. Drupal core no
113 * longer creates an active directory.
115 * @see https://www.drupal.org/node/2501187
117 const CONFIG_ACTIVE_DIRECTORY = 'active';
120 * $config_directories key for sync directory.
122 * @see config_get_config_directory()
124 const CONFIG_SYNC_DIRECTORY = 'sync';
127 * $config_directories key for staging directory.
129 * @see config_get_config_directory()
130 * @see CONFIG_SYNC_DIRECTORY
132 * @deprecated in Drupal 8.0.x and will be removed before 9.0.0. The staging
133 * directory was renamed to sync.
135 * @see https://www.drupal.org/node/2574957
137 const CONFIG_STAGING_DIRECTORY = 'staging';
140 * Defines the root directory of the Drupal installation.
142 * This strips two levels of directories off the current directory.
144 define('DRUPAL_ROOT', dirname(dirname(__DIR__)));
147 * Returns the path of a configuration directory.
149 * Configuration directories are configured using $config_directories in
152 * @param string $type
153 * The type of config directory to return. Drupal core provides the
154 * CONFIG_SYNC_DIRECTORY constant to access the sync directory.
157 * The configuration directory path.
161 function config_get_config_directory($type) {
162 global $config_directories;
164 // @todo Remove fallback in Drupal 9. https://www.drupal.org/node/2574943
165 if ($type == CONFIG_SYNC_DIRECTORY && !isset($config_directories[CONFIG_SYNC_DIRECTORY]) && isset($config_directories[CONFIG_STAGING_DIRECTORY])) {
166 $type = CONFIG_STAGING_DIRECTORY;
169 if (!empty($config_directories[$type])) {
170 return $config_directories[$type];
172 // @todo https://www.drupal.org/node/2696103 Throw a more specific exception.
173 throw new \Exception("The configuration directory type '$type' does not exist");
177 * Returns and optionally sets the filename for a system resource.
179 * The filename, whether provided, cached, or retrieved from the database, is
180 * only returned if the file exists.
182 * This function plays a key role in allowing Drupal's resources (modules
183 * and themes) to be located in different places depending on a site's
184 * configuration. For example, a module 'foo' may legally be located
185 * in any of these three places:
187 * core/modules/foo/foo.info.yml
188 * modules/foo/foo.info.yml
189 * sites/example.com/modules/foo/foo.info.yml
191 * Calling drupal_get_filename('module', 'foo') will give you one of
192 * the above, depending on where the module is located.
195 * The type of the item; one of 'core', 'profile', 'module', 'theme', or
198 * The name of the item for which the filename is requested. Ignored for
201 * The filename of the item if it is to be set explicitly rather
202 * than by consulting the database.
205 * The filename of the requested item or NULL if the item is not found.
207 function drupal_get_filename($type, $name, $filename = NULL) {
208 // The location of files will not change during the request, so do not use
212 // Type 'core' only exists to simplify application-level logic; it always maps
213 // to the /core directory, whereas $name is ignored. It is only requested via
214 // drupal_get_path(). /core/core.info.yml does not exist, but is required
215 // since drupal_get_path() returns the dirname() of the returned pathname.
216 if ($type === 'core') {
217 return 'core/core.info.yml';
220 // Profiles are converted into modules in system_rebuild_module_data().
221 // @todo Remove false-exposure of profiles as modules.
222 if ($type == 'profile') {
225 if (!isset($files[$type])) {
229 if (isset($filename)) {
230 $files[$type][$name] = $filename;
232 elseif (!isset($files[$type][$name])) {
233 // If the pathname of the requested extension is not known, try to retrieve
234 // the list of extension pathnames from various providers, checking faster
236 // Retrieve the current module list (derived from the service container).
237 if ($type == 'module' && \Drupal::hasService('module_handler')) {
238 foreach (\Drupal::moduleHandler()->getModuleList() as $module_name => $module) {
239 $files[$type][$module_name] = $module->getPathname();
242 // If still unknown, retrieve the file list prepared in state by
243 // system_rebuild_module_data() and
244 // \Drupal\Core\Extension\ThemeHandlerInterface::rebuildThemeData().
245 if (!isset($files[$type][$name]) && \Drupal::hasService('state')) {
246 $files[$type] += \Drupal::state()->get('system.' . $type . '.files', []);
248 // If still unknown, create a user-level error message.
249 if (!isset($files[$type][$name])) {
250 trigger_error(SafeMarkup::format('The following @type is missing from the file system: @name', ['@type' => $type, '@name' => $name]), E_USER_WARNING);
254 if (isset($files[$type][$name])) {
255 return $files[$type][$name];
260 * Returns the path to a system item (module, theme, etc.).
263 * The type of the item; one of 'core', 'profile', 'module', 'theme', or
266 * The name of the item for which the path is requested. Ignored for
270 * The path to the requested item or an empty string if the item is not found.
272 function drupal_get_path($type, $name) {
273 return dirname(drupal_get_filename($type, $name));
277 * Translates a string to the current language or to a given language.
279 * In order for strings to be localized, make them available in one of the ways
280 * supported by the @link i18n Localization API. @endlink When possible, use
281 * the \Drupal\Core\StringTranslation\StringTranslationTrait $this->t().
282 * Otherwise create a new \Drupal\Core\StringTranslation\TranslatableMarkup
285 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
286 * important security information and usage guidelines.
288 * @param string $string
289 * A string containing the English text to translate.
291 * (optional) An associative array of replacements to make after translation.
292 * Based on the first character of the key, the value is escaped and/or
294 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
296 * @param array $options
297 * (optional) An associative array of additional options, with the following
299 * - 'langcode' (defaults to the current language): A language code, to
300 * translate to a language other than what is used to display the page.
301 * - 'context' (defaults to the empty context): The context the source string
302 * belongs to. See the @link i18n Internationalization topic @endlink for
303 * more information about string contexts.
305 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
306 * An object that, when cast to a string, returns the translated string.
308 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
309 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
310 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
312 * @ingroup sanitization
314 function t($string, array $args = [], array $options = []) {
315 return new TranslatableMarkup($string, $args, $options);
319 * Formats a string for HTML display by replacing variable placeholders.
321 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
322 * @see \Drupal\Component\Render\FormattableMarkup
324 * @ingroup sanitization
326 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
327 * Use \Drupal\Component\Render\FormattableMarkup.
329 * @see https://www.drupal.org/node/2302363
331 function format_string($string, array $args) {
332 return SafeMarkup::format($string, $args);
336 * Checks whether a string is valid UTF-8.
338 * All functions designed to filter input should use drupal_validate_utf8
339 * to ensure they operate on valid UTF-8 strings to prevent bypass of the
342 * When text containing an invalid UTF-8 lead byte (0xC0 - 0xFF) is presented
343 * as UTF-8 to Internet Explorer 6, the program may misinterpret subsequent
344 * bytes. When these subsequent bytes are HTML control characters such as
345 * quotes or angle brackets, parts of the text that were deemed safe by filters
346 * end up in locations that are potentially unsafe; An onerror attribute that
347 * is outside of a tag, and thus deemed safe by a filter, can be interpreted
348 * by the browser as if it were inside the tag.
350 * The function does not return FALSE for strings containing character codes
351 * above U+10FFFF, even though these are prohibited by RFC 3629.
357 * TRUE if the text is valid UTF-8, FALSE if not.
359 * @see \Drupal\Component\Utility\Unicode::validateUtf8()
361 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
362 * Use \Drupal\Component\Utility\Unicode::validateUtf8().
364 * @see https://www.drupal.org/node/1992584
366 function drupal_validate_utf8($text) {
367 return Unicode::validateUtf8($text);
373 * This is a wrapper logging function which automatically decodes an exception.
376 * The category to which this message belongs.
378 * The exception that is going to be logged.
380 * The message to store in the log. If empty, a text that contains all useful
381 * information about the passed-in exception is used.
383 * Array of variables to replace in the message on display or
384 * NULL if message is already translated or not possible to
387 * The severity of the message, as per RFC 3164.
389 * A link to associate with the message.
391 * @see \Drupal\Core\Utility\Error::decodeException()
393 function watchdog_exception($type, Exception $exception, $message = NULL, $variables = [], $severity = RfcLogLevel::ERROR, $link = NULL) {
395 // Use a default value if $message is not set.
396 if (empty($message)) {
397 $message = '%type: @message in %function (line %line of %file).';
401 $variables['link'] = $link;
404 $variables += Error::decodeException($exception);
406 \Drupal::logger($type)->log($severity, $message, $variables);
410 * Sets a message to display to the user.
412 * Messages are stored in a session variable and displayed in the page template
413 * via the $messages theme variable.
417 * drupal_set_message(t('An error occurred and processing did not complete.'), 'error');
420 * @param string|\Drupal\Component\Render\MarkupInterface $message
421 * (optional) The translated message to be displayed to the user. For
422 * consistency with other messages, it should begin with a capital letter and
424 * @param string $type
425 * (optional) The message's type. Defaults to 'status'. These values are
430 * @param bool $repeat
431 * (optional) If this is FALSE and the message is already set, then the
432 * message won't be repeated. Defaults to FALSE.
435 * A multidimensional array with keys corresponding to the set message types.
436 * The indexed array values of each contain the set messages for that type,
437 * and each message is an associative array with the following format:
438 * - safe: Boolean indicating whether the message string has been marked as
439 * safe. Non-safe strings will be escaped automatically.
440 * - message: The message string.
441 * So, the following is an example of the full return array structure:
447 * 'message' => 'A <em>safe</em> markup string.',
451 * 'message' => "$arbitrary_user_input to escape.",
456 * If there are no messages set, the function returns NULL.
458 * @see drupal_get_messages()
459 * @see status-messages.html.twig
461 function drupal_set_message($message = NULL, $type = 'status', $repeat = FALSE) {
462 if (isset($message)) {
463 if (!isset($_SESSION['messages'][$type])) {
464 $_SESSION['messages'][$type] = [];
467 // Convert strings which are safe to the simplest Markup objects.
468 if (!($message instanceof Markup) && $message instanceof MarkupInterface) {
469 $message = Markup::create((string) $message);
472 // Do not use strict type checking so that equivalent string and
473 // MarkupInterface objects are detected.
474 if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
475 $_SESSION['messages'][$type][] = $message;
478 // Mark this page as being uncacheable.
479 \Drupal::service('page_cache_kill_switch')->trigger();
482 // Messages not set when DB connection fails.
483 return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
487 * Returns all messages that have been set with drupal_set_message().
489 * @param string $type
490 * (optional) Limit the messages returned by type. Defaults to NULL, meaning
491 * all types. These values are supported:
496 * @param bool $clear_queue
497 * (optional) If this is TRUE, the queue will be cleared of messages of the
498 * type specified in the $type parameter. Otherwise the queue will be left
499 * intact. Defaults to TRUE.
502 * An associative, nested array of messages grouped by message type, with
503 * the top-level keys as the message type. The messages returned are
504 * limited to the type specified in the $type parameter, if any. If there
505 * are no messages of the specified type, an empty array is returned. See
506 * drupal_set_message() for the array structure of individual messages.
508 * @see drupal_set_message()
509 * @see status-messages.html.twig
511 function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
512 if ($messages = drupal_set_message()) {
515 unset($_SESSION['messages'][$type]);
517 if (isset($messages[$type])) {
518 return [$type => $messages[$type]];
523 unset($_SESSION['messages']);
532 * Returns the time zone of the current user.
534 function drupal_get_user_timezone() {
535 $user = \Drupal::currentUser();
536 $config = \Drupal::config('system.date');
538 if ($user && $config->get('timezone.user.configurable') && $user->isAuthenticated() && $user->getTimezone()) {
539 return $user->getTimezone();
542 // Ignore PHP strict notice if time zone has not yet been set in the php.ini
544 $config_data_default_timezone = $config->get('timezone.default');
545 return !empty($config_data_default_timezone) ? $config_data_default_timezone : @date_default_timezone_get();
550 * Provides custom PHP error handling.
552 * @param $error_level
553 * The level of the error raised.
557 * The filename that the error was raised in.
559 * The line number the error was raised at.
561 * An array that points to the active symbol table at the point the error
564 function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
565 require_once __DIR__ . '/errors.inc';
566 _drupal_error_handler_real($error_level, $message, $filename, $line, $context);
570 * Provides custom PHP exception handling.
572 * Uncaught exceptions are those not enclosed in a try/catch block. They are
573 * always fatal: the execution of the script will stop as soon as the exception
576 * @param \Exception|\Throwable $exception
577 * The exception object that was thrown.
579 function _drupal_exception_handler($exception) {
580 require_once __DIR__ . '/errors.inc';
583 // Log the message to the watchdog and return an error page to the user.
584 _drupal_log_error(Error::decodeException($exception), TRUE);
586 // PHP 7 introduces Throwable, which covers both Error and
587 // Exception throwables.
588 catch (\Throwable $error) {
589 _drupal_exception_handler_additional($exception, $error);
591 // In order to be compatible with PHP 5 we also catch regular Exceptions.
592 catch (\Exception $exception2) {
593 _drupal_exception_handler_additional($exception, $exception2);
598 * Displays any additional errors caught while handling an exception.
600 * @param \Exception|\Throwable $exception
601 * The first exception object that was thrown.
602 * @param \Exception|\Throwable $exception2
603 * The second exception object that was thrown.
605 function _drupal_exception_handler_additional($exception, $exception2) {
606 // Another uncaught exception was thrown while handling the first one.
607 // If we are displaying errors, then do so with no possibility of a further
608 // uncaught exception being thrown.
609 if (error_displayable()) {
610 print '<h1>Additional uncaught exception thrown while handling exception.</h1>';
611 print '<h2>Original</h2><p>' . Error::renderExceptionSafe($exception) . '</p>';
612 print '<h2>Additional</h2><p>' . Error::renderExceptionSafe($exception2) . '</p><hr />';
617 * Returns the test prefix if this is an internal request from SimpleTest.
619 * @param string $new_prefix
620 * Internal use only. A new prefix to be stored.
622 * @return string|false
623 * Either the simpletest prefix (the string "simpletest" followed by any
624 * number of digits) or FALSE if the user agent does not contain a valid
625 * HMAC and timestamp.
627 function drupal_valid_test_ua($new_prefix = NULL) {
630 if (isset($new_prefix)) {
631 $test_prefix = $new_prefix;
633 if (isset($test_prefix)) {
636 // Unless the below User-Agent and HMAC validation succeeds, we are not in
637 // a test environment.
638 $test_prefix = FALSE;
640 // A valid Simpletest request will contain a hashed and salted authentication
641 // code. Check if this code is present in a cookie or custom user agent
643 $http_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : NULL;
644 $user_agent = isset($_COOKIE['SIMPLETEST_USER_AGENT']) ? $_COOKIE['SIMPLETEST_USER_AGENT'] : $http_user_agent;
645 if (isset($user_agent) && preg_match("/^simple(\w+\d+):(.+):(.+):(.+)$/", $user_agent, $matches)) {
646 list(, $prefix, $time, $salt, $hmac) = $matches;
647 $check_string = $prefix . ':' . $time . ':' . $salt;
648 // Read the hash salt prepared by drupal_generate_test_ua().
649 // This function is called before settings.php is read and Drupal's error
650 // handlers are set up. While Drupal's error handling may be properly
651 // configured on production sites, the server's PHP error_reporting may not.
652 // Ensure that no information leaks on production sites.
653 $test_db = new TestDatabase($prefix);
654 $key_file = DRUPAL_ROOT . '/' . $test_db->getTestSitePath() . '/.htkey';
655 if (!is_readable($key_file)) {
656 header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
659 $private_key = file_get_contents($key_file);
660 // The file properties add more entropy not easily accessible to others.
661 $key = $private_key . filectime(__FILE__) . fileinode(__FILE__);
662 $time_diff = REQUEST_TIME - $time;
663 $test_hmac = Crypt::hmacBase64($check_string, $key);
664 // Since we are making a local request a 600 second time window is allowed,
665 // and the HMAC must match.
666 if ($time_diff >= 0 && $time_diff <= 600 && $hmac === $test_hmac) {
667 $test_prefix = $prefix;
670 header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden (SIMPLETEST_USER_AGENT invalid)');
678 * Generates a user agent string with a HMAC and timestamp for simpletest.
680 function drupal_generate_test_ua($prefix) {
681 static $key, $last_prefix;
683 if (!isset($key) || $last_prefix != $prefix) {
684 $last_prefix = $prefix;
685 $test_db = new TestDatabase($prefix);
686 $key_file = DRUPAL_ROOT . '/' . $test_db->getTestSitePath() . '/.htkey';
687 // When issuing an outbound HTTP client request from within an inbound test
688 // request, then the outbound request has to use the same User-Agent header
689 // as the inbound request. A newly generated private key for the same test
690 // prefix would invalidate all subsequent inbound requests.
691 // @see \Drupal\Core\Http\Plugin\SimpletestHttpRequestSubscriber
692 if (DRUPAL_TEST_IN_CHILD_SITE && $parent_prefix = drupal_valid_test_ua()) {
693 if ($parent_prefix != $prefix) {
694 throw new \RuntimeException("Malformed User-Agent: Expected '$parent_prefix' but got '$prefix'.");
696 // If the file is not readable, a PHP warning is expected in this case.
697 $private_key = file_get_contents($key_file);
700 // Generate and save a new hash salt for a test run.
701 // Consumed by drupal_valid_test_ua() before settings.php is loaded.
702 $private_key = Crypt::randomBytesBase64(55);
703 file_put_contents($key_file, $private_key);
705 // The file properties add more entropy not easily accessible to others.
706 $key = $private_key . filectime(__FILE__) . fileinode(__FILE__);
708 // Generate a moderately secure HMAC based on the database credentials.
709 $salt = uniqid('', TRUE);
710 $check_string = $prefix . ':' . time() . ':' . $salt;
711 return 'simple' . $check_string . ':' . Crypt::hmacBase64($check_string, $key);
715 * Enables use of the theme system without requiring database access.
717 * Loads and initializes the theme system for site installs, updates and when
718 * the site is in maintenance mode. This also applies when the database fails.
720 * @see _drupal_maintenance_theme()
722 function drupal_maintenance_theme() {
723 require_once __DIR__ . '/theme.maintenance.inc';
724 _drupal_maintenance_theme();
728 * Returns TRUE if a Drupal installation is currently being attempted.
730 function drupal_installation_attempted() {
731 // This cannot rely on the MAINTENANCE_MODE constant, since that would prevent
732 // tests from using the non-interactive installer, in which case Drupal
733 // only happens to be installed within the same request, but subsequently
734 // executed code does not involve the installer at all.
735 // @see install_drupal()
736 return isset($GLOBALS['install_state']) && empty($GLOBALS['install_state']['installation_finished']);
740 * Gets the name of the currently active installation profile.
742 * When this function is called during Drupal's initial installation process,
743 * the name of the profile that's about to be installed is stored in the global
744 * installation state. At all other times, the "install_profile" setting will be
745 * available in container as a parameter.
747 * @return string|null
748 * The name of the installation profile or NULL if no installation profile is
749 * currently active. This is the case for example during the first steps of
750 * the installer or during unit tests.
752 * @deprecated in Drupal 8.3.0, will be removed before Drupal 9.0.0.
753 * Use the install_profile container parameter or \Drupal::installProfile()
754 * instead. If you are accessing the value before it is written to
755 * configuration during the installer use the $install_state global. If you
756 * need to access the value before container is available you can use
757 * BootstrapConfigStorageFactory to load the value directly from
760 * @see https://www.drupal.org/node/2538996
762 function drupal_get_profile() {
763 global $install_state;
765 if (drupal_installation_attempted()) {
766 // If the profile has been selected return it.
767 if (isset($install_state['parameters']['profile'])) {
768 $profile = $install_state['parameters']['profile'];
775 if (\Drupal::hasContainer()) {
776 $profile = \Drupal::installProfile();
779 $profile = BootstrapConfigStorageFactory::getDatabaseStorage()->read('core.extension')['profile'];
782 // A BC layer just in in case this only exists in Settings. Introduced in
783 // Drupal 8.3.x and will be removed before Drupal 9.0.0.
784 if (empty($profile)) {
785 $profile = Settings::get('install_profile');
793 * Registers an additional namespace.
795 * @param string $name
796 * The namespace component to register; e.g., 'node'.
797 * @param string $path
798 * The relative path to the Drupal component in the filesystem.
800 function drupal_classloader_register($name, $path) {
801 $loader = \Drupal::service('class_loader');
802 $loader->addPsr4('Drupal\\' . $name . '\\', \Drupal::root() . '/' . $path . '/src');
806 * Provides central static variable storage.
808 * All functions requiring a static variable to persist or cache data within
809 * a single page request are encouraged to use this function unless it is
810 * absolutely certain that the static variable will not need to be reset during
811 * the page request. By centralizing static variable storage through this
812 * function, other functions can rely on a consistent API for resetting any
813 * other function's static variables.
817 * function example_list($field = 'default') {
818 * $examples = &drupal_static(__FUNCTION__);
819 * if (!isset($examples)) {
820 * // If this function is being called for the first time after a reset,
821 * // query the database and execute any other code needed to retrieve
825 * if (!isset($examples[$field])) {
826 * // If this function is being called for the first time for a particular
827 * // index field, then execute code needed to index the information already
828 * // available in $examples by the desired field.
831 * // Subsequent invocations of this function for a particular index field
832 * // skip the above two code blocks and quickly return the already indexed
834 * return $examples[$field];
836 * function examples_admin_overview() {
837 * // When building the content for the overview page, make sure to get
838 * // completely fresh information.
839 * drupal_static_reset('example_list');
844 * In a few cases, a function can have certainty that there is no legitimate
845 * use-case for resetting that function's static variable. This is rare,
846 * because when writing a function, it's hard to forecast all the situations in
847 * which it will be used. A guideline is that if a function's static variable
848 * does not depend on any information outside of the function that might change
849 * during a single page request, then it's ok to use the "static" keyword
850 * instead of the drupal_static() function.
854 * function mymodule_log_stream_handle($new_handle = NULL) {
856 * if (isset($new_handle)) {
857 * $handle = $new_handle;
863 * In a few cases, a function needs a resettable static variable, but the
864 * function is called many times (100+) during a single page request, so
865 * every microsecond of execution time that can be removed from the function
866 * counts. These functions can use a more cumbersome, but faster variant of
867 * calling drupal_static(). It works by storing the reference returned by
868 * drupal_static() in the calling function's own static variable, thereby
869 * removing the need to call drupal_static() for each iteration of the function.
870 * Conceptually, it replaces:
872 * $foo = &drupal_static(__FUNCTION__);
876 * // Unfortunately, this does not work.
877 * static $foo = &drupal_static(__FUNCTION__);
879 * However, the above line of code does not work, because PHP only allows static
880 * variables to be initialized by literal values, and does not allow static
881 * variables to be assigned to references.
882 * - http://php.net/manual/language.variables.scope.php#language.variables.scope.static
883 * - http://php.net/manual/language.variables.scope.php#language.variables.scope.references
884 * The example below shows the syntax needed to work around both limitations.
885 * For benchmarks and more information, see https://www.drupal.org/node/619666.
889 * function example_default_format_type() {
890 * // Use the advanced drupal_static() pattern, since this is called very often.
891 * static $drupal_static_fast;
892 * if (!isset($drupal_static_fast)) {
893 * $drupal_static_fast['format_type'] = &drupal_static(__FUNCTION__);
895 * $format_type = &$drupal_static_fast['format_type'];
901 * Globally unique name for the variable. For a function with only one static,
902 * variable, the function name (e.g. via the PHP magic __FUNCTION__ constant)
903 * is recommended. For a function with multiple static variables add a
904 * distinguishing suffix to the function name for each one.
905 * @param $default_value
906 * Optional default value.
908 * TRUE to reset one or all variables(s). This parameter is only used
909 * internally and should not be passed in; use drupal_static_reset() instead.
910 * (This function's return value should not be used when TRUE is passed in.)
913 * Returns a variable by reference.
915 * @see drupal_static_reset()
917 function &drupal_static($name, $default_value = NULL, $reset = FALSE) {
918 static $data = [], $default = [];
919 // First check if dealing with a previously defined static variable.
920 if (isset($data[$name]) || array_key_exists($name, $data)) {
921 // Non-NULL $name and both $data[$name] and $default[$name] statics exist.
923 // Reset pre-existing static variable to its default value.
924 $data[$name] = $default[$name];
928 // Neither $data[$name] nor $default[$name] static variables exist.
931 // Reset was called before a default is set and yet a variable must be
935 // First call with new non-NULL $name. Initialize a new static variable.
936 $default[$name] = $data[$name] = $default_value;
939 // Reset all: ($name == NULL). This needs to be done one at a time so that
940 // references returned by earlier invocations of drupal_static() also get
942 foreach ($default as $name => $value) {
943 $data[$name] = $value;
945 // As the function returns a reference, the return should always be a
951 * Resets one or all centrally stored static variable(s).
954 * Name of the static variable to reset. Omit to reset all variables.
955 * Resetting all variables should only be used, for example, for running
956 * unit tests with a clean environment.
958 function drupal_static_reset($name = NULL) {
959 drupal_static($name, NULL, TRUE);
963 * Formats text for emphasized display in a placeholder inside a sentence.
965 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0. Use
966 * \Drupal\Component\Utility\SafeMarkup::format() or Twig's "placeholder"
967 * filter instead. Note this method should not be used to simply emphasize a
968 * string and therefore has few valid use-cases. Note also, that this method
969 * does not mark the string as safe.
971 * @see https://www.drupal.org/node/2302363
973 function drupal_placeholder($text) {
974 return '<em class="placeholder">' . Html::escape($text) . '</em>';
978 * Registers a function for execution on shutdown.
980 * Wrapper for register_shutdown_function() that catches thrown exceptions to
981 * avoid "Exception thrown without a stack frame in Unknown".
984 * The shutdown function to register.
986 * Additional arguments to pass to the shutdown function.
989 * Array of shutdown functions to be executed.
991 * @see register_shutdown_function()
992 * @ingroup php_wrappers
994 function &drupal_register_shutdown_function($callback = NULL) {
995 // We cannot use drupal_static() here because the static cache is reset during
996 // batch processing, which breaks batch handling.
997 static $callbacks = [];
999 if (isset($callback)) {
1000 // Only register the internal shutdown function once.
1001 if (empty($callbacks)) {
1002 register_shutdown_function('_drupal_shutdown_function');
1004 $args = func_get_args();
1005 // Remove $callback from the arguments.
1007 // Save callback and arguments
1008 $callbacks[] = ['callback' => $callback, 'arguments' => $args];
1014 * Executes registered shutdown functions.
1016 function _drupal_shutdown_function() {
1017 $callbacks = &drupal_register_shutdown_function();
1019 // Set the CWD to DRUPAL_ROOT as it is not guaranteed to be the same as it
1020 // was in the normal context of execution.
1024 while (list($key, $callback) = each($callbacks)) {
1025 call_user_func_array($callback['callback'], $callback['arguments']);
1028 // PHP 7 introduces Throwable, which covers both Error and
1029 // Exception throwables.
1030 catch (\Throwable $error) {
1031 _drupal_shutdown_function_handle_exception($error);
1033 // In order to be compatible with PHP 5 we also catch regular Exceptions.
1034 catch (\Exception $exception) {
1035 _drupal_shutdown_function_handle_exception($exception);
1040 * Displays and logs any errors that may happen during shutdown.
1042 * @param \Exception|\Throwable $exception
1043 * The exception object that was thrown.
1045 * @see _drupal_shutdown_function()
1047 function _drupal_shutdown_function_handle_exception($exception) {
1048 // If using PHP-FPM then fastcgi_finish_request() will have been fired
1049 // preventing further output to the browser.
1050 if (!function_exists('fastcgi_finish_request')) {
1051 // If we are displaying errors, then do so with no possibility of a
1052 // further uncaught exception being thrown.
1053 require_once __DIR__ . '/errors.inc';
1054 if (error_displayable()) {
1055 print '<h1>Uncaught exception thrown in shutdown function.</h1>';
1056 print '<p>' . Error::renderExceptionSafe($exception) . '</p><hr />';
1059 error_log($exception);