bootstrap.inc 35.4 KB
Newer Older
1
<?php
2 3 4 5
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
 
Dries committed
6

7
use Drupal\Component\Utility\Crypt;
8
use Drupal\Component\Utility\Html;
9
use Drupal\Component\Utility\SafeMarkup;
10
use Drupal\Component\Utility\Unicode;
11
use Drupal\Core\Logger\RfcLogLevel;
12 13
use Drupal\Core\Render\Markup;
use Drupal\Component\Render\MarkupInterface;
14
use Drupal\Core\Session\AccountInterface;
15
use Drupal\Core\Site\Settings;
16
use Drupal\Core\Utility\Error;
17
use Drupal\Core\StringTranslation\TranslatableMarkup;
18

19 20
/**
 * Minimum supported version of PHP.
21
 */
22
const DRUPAL_MINIMUM_PHP = '5.5.9';
23 24 25

/**
 * Minimum recommended value of PHP memory_limit.
26
 *
27 28 29
 * 64M was chosen as a minimum requirement in order to allow for additional
 * contributed modules to be installed prior to hitting the limit. However,
 * 40M is the target for the Standard installation profile.
30
 */
31
const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '64M';
32

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/**
 * 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';

53 54
/**
 * Role ID for anonymous users; should match what's in the "role" table.
55 56 57 58
 *
 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
 *   Use Drupal\Core\Session\AccountInterface::ANONYMOUS_ROLE or
 *   \Drupal\user\RoleInterface::ANONYMOUS_ID instead.
59
 */
60
const DRUPAL_ANONYMOUS_RID = AccountInterface::ANONYMOUS_ROLE;
61 62 63

/**
 * Role ID for authenticated users; should match what's in the "role" table.
64 65 66 67
 *
 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
 *   Use Drupal\Core\Session\AccountInterface::AUTHENTICATED_ROLE or
 *   \Drupal\user\RoleInterface::AUTHENTICATED_ID instead.
68
 */
69
const DRUPAL_AUTHENTICATED_RID = AccountInterface::AUTHENTICATED_ROLE;
70

71 72 73 74 75
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

76
/**
77
 * Time of the current request in seconds elapsed since the Unix Epoch.
78
 *
79 80 81 82 83 84
 * 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
85
 */
86
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
87

88 89 90
/**
 * Regular expression to match PHP function names.
 *
91
 * @see http://php.net/manual/language.functions.php
92
 */
93
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
94

95 96 97
/**
 * $config_directories key for active directory.
 *
98
 * @see config_get_config_directory()
99 100 101
 *
 * @deprecated in Drupal 8.0.x and will be removed before 9.0.0. Drupal core no
 *   longer creates an active directory.
102 103 104
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

105 106 107 108 109 110 111
/**
 * $config_directories key for sync directory.
 *
 * @see config_get_config_directory()
 */
const CONFIG_SYNC_DIRECTORY = 'sync';

112 113 114
/**
 * $config_directories key for staging directory.
 *
115
 * @see config_get_config_directory()
116 117 118 119
 * @see CONFIG_SYNC_DIRECTORY
 *
 * @deprecated in Drupal 8.0.x and will be removed before 9.0.0. The staging
 *   directory was renamed to sync.
120 121 122
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

123 124 125 126 127 128 129
/**
 * Defines the root directory of the Drupal installation.
 *
 * This strips two levels of directories off the current directory.
 */
define('DRUPAL_ROOT', dirname(dirname(__DIR__)));

130
/**
131 132
 * Returns the path of a configuration directory.
 *
133 134 135
 * Configuration directories are configured using $config_directories in
 * settings.php.
 *
136
 * @param string $type
137
 *   The type of config directory to return. Drupal core provides the
138
 *   CONFIG_SYNC_DIRECTORY constant to access the sync directory.
139 140 141
 *
 * @return string
 *   The configuration directory path.
142 143
 *
 * @throws \Exception
144
 */
145
function config_get_config_directory($type) {
146
  global $config_directories;
147

148 149 150 151 152
  // @todo Remove fallback in Drupal 9. https://www.drupal.org/node/2574943
  if ($type == CONFIG_SYNC_DIRECTORY && !isset($config_directories[CONFIG_SYNC_DIRECTORY]) && isset($config_directories[CONFIG_STAGING_DIRECTORY])) {
    $type = CONFIG_STAGING_DIRECTORY;
  }

153
  if (!empty($config_directories[$type])) {
154
    return $config_directories[$type];
155
  }
156
  // @todo https://www.drupal.org/node/2696103 Throw a more specific exception.
157
  throw new \Exception("The configuration directory type '$type' does not exist");
158 159
}

Dries's avatar
Dries committed
160
/**
161 162 163 164
 * 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.
Dries's avatar
Dries committed
165
 *
Dries's avatar
Dries committed
166 167
 * 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
168
 * configuration. For example, a module 'foo' may legally be located
Dries's avatar
Dries committed
169 170
 * in any of these three places:
 *
171 172 173
 * core/modules/foo/foo.info.yml
 * modules/foo/foo.info.yml
 * sites/example.com/modules/foo/foo.info.yml
Dries's avatar
Dries committed
174 175 176 177
 *
 * Calling drupal_get_filename('module', 'foo') will give you one of
 * the above, depending on where the module is located.
 *
Dries's avatar
Dries committed
178
 * @param $type
179 180
 *   The type of the item; one of 'core', 'profile', 'module', 'theme', or
 *   'theme_engine'.
Dries's avatar
Dries committed
181
 * @param $name
182 183
 *   The name of the item for which the filename is requested. Ignored for
 *   $type 'core'.
Dries's avatar
Dries committed
184 185 186 187 188
 * @param $filename
 *   The filename of the item if it is to be set explicitly rather
 *   than by consulting the database.
 *
 * @return
189
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
190
 */
Dries's avatar
Dries committed
191
function drupal_get_filename($type, $name, $filename = NULL) {
192 193
  // The location of files will not change during the request, so do not use
  // drupal_static().
194
  static $files = array();
Dries's avatar
Dries committed
195

196 197 198 199 200 201 202 203
  // 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';
  }

204 205
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
206
  if ($type == 'profile') {
207
    $type = 'module';
208
  }
209
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
210 211 212
    $files[$type] = array();
  }

213
  if (isset($filename)) {
Dries's avatar
Dries committed
214 215
    $files[$type][$name] = $filename;
  }
216 217 218 219 220 221
  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')) {
222 223 224
      foreach (\Drupal::moduleHandler()->getModuleList() as $module_name => $module) {
        $files[$type][$module_name] = $module->getPathname();
      }
225 226
    }
    // If still unknown, retrieve the file list prepared in state by
227 228
    // system_rebuild_module_data() and
    // \Drupal\Core\Extension\ThemeHandlerInterface::rebuildThemeData().
229 230
    if (!isset($files[$type][$name]) && \Drupal::hasService('state')) {
      $files[$type] += \Drupal::state()->get('system.' . $type . '.files', array());
231
    }
232
    // If still unknown, create a user-level error message.
233
    if (!isset($files[$type][$name])) {
234
      trigger_error(SafeMarkup::format('The following @type is missing from the file system: @name', array('@type' => $type, '@name' => $name)), E_USER_WARNING);
Dries's avatar
Dries committed
235 236 237
    }
  }

238 239 240
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
241 242
}

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
/**
 * Returns the path to a system item (module, theme, etc.).
 *
 * @param $type
 *   The type of the item; one of 'core', 'profile', 'module', 'theme', or
 *   'theme_engine'.
 * @param $name
 *   The name of the item for which the path is requested. Ignored for
 *   $type 'core'.
 *
 * @return
 *   The path to the requested item or an empty string if the item is not found.
 */
function drupal_get_path($type, $name) {
  return dirname(drupal_get_filename($type, $name));
}

260
/**
261
 * Translates a string to the current language or to a given language.
262
 *
263
 * In order for strings to be localized, make them available in one of the ways
264 265 266 267
 * supported by the @link i18n Localization API. @endlink When possible, use
 * the \Drupal\Core\StringTranslation\StringTranslationTrait $this->t().
 * Otherwise create a new \Drupal\Core\StringTranslation\TranslatableMarkup
 * object directly.
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) 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
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
284 285
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source string
286 287
 *     belongs to. See the @link i18n Internationalization topic @endlink for
 *     more information about string contexts.
288
 *
289
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
290 291 292 293 294
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
295 296
 *
 * @ingroup sanitization
297 298
 */
function t($string, array $args = array(), array $options = array()) {
299
  return new TranslatableMarkup($string, $args, $options);
300 301 302
}

/**
303 304
 * Formats a string for HTML display by replacing variable placeholders.
 *
305 306
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Component\Render\FormattableMarkup
307 308
 * @see t()
 * @ingroup sanitization
309 310
 *
 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
311
 *   Use \Drupal\Component\Render\FormattableMarkup.
312
 */
313
function format_string($string, array $args) {
314
  return SafeMarkup::format($string, $args);
315 316
}

Gábor Hojtsy's avatar
Gábor Hojtsy committed
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
/**
 * 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.
 *
332 333
 * The function does not return FALSE for strings containing character codes
 * above U+10FFFF, even though these are prohibited by RFC 3629.
Gábor Hojtsy's avatar
Gábor Hojtsy committed
334 335 336
 *
 * @param $text
 *   The text to check.
337
 *
338
 * @return bool
Gábor Hojtsy's avatar
Gábor Hojtsy committed
339
 *   TRUE if the text is valid UTF-8, FALSE if not.
340 341
 *
 * @see \Drupal\Component\Utility\Unicode::validateUtf8()
342 343 344
 *
 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
 *   Use \Drupal\Component\Utility\Unicode::validateUtf8().
Gábor Hojtsy's avatar
Gábor Hojtsy committed
345 346
 */
function drupal_validate_utf8($text) {
347
  return Unicode::validateUtf8($text);
Dries's avatar
Dries committed
348 349
}

350
/**
351
 * Logs an exception.
352
 *
353
 * This is a wrapper logging function which automatically decodes an exception.
354 355 356 357 358 359 360
 *
 * @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
361
 *   information about the passed-in exception is used.
362
 * @param $variables
363 364 365
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
366 367 368 369 370
 * @param $severity
 *   The severity of the message, as per RFC 3164.
 * @param $link
 *   A link to associate with the message.
 *
371
 * @see \Drupal\Core\Utility\Error::decodeException()
372
 */
373
function watchdog_exception($type, Exception $exception, $message = NULL, $variables = array(), $severity = RfcLogLevel::ERROR, $link = NULL) {
374

375 376
  // Use a default value if $message is not set.
  if (empty($message)) {
377
    $message = '%type: @message in %function (line %line of %file).';
378 379 380 381 382 383 384 385 386
  }

  if ($link) {
    $variables['link'] = $link;
  }

  $variables += Error::decodeException($exception);

  \Drupal::logger($type)->log($severity, $message, $variables);
387 388
}

Dries's avatar
 
Dries committed
389
/**
390
 * Sets a message to display to the user.
Dries's avatar
 
Dries committed
391
 *
392 393
 * Messages are stored in a session variable and displayed in the page template
 * via the $messages theme variable.
Dries's avatar
 
Dries committed
394
 *
395 396 397 398 399
 * Example usage:
 * @code
 * drupal_set_message(t('An error occurred and processing did not complete.'), 'error');
 * @endcode
 *
400
 * @param string|\Drupal\Component\Render\MarkupInterface $message
401 402 403 404 405 406
 *   (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:
407
 *   - 'status'
408
 *   - 'warning'
409
 *   - 'error'
410 411
 * @param bool $repeat
 *   (optional) If this is FALSE and the message is already set, then the
412
 *   message won't be repeated. Defaults to FALSE.
413 414 415
 *
 * @return array|null
 *   A multidimensional array with keys corresponding to the set message types.
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
 *   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.
437 438
 *
 * @see drupal_get_messages()
439
 * @see status-messages.html.twig
Dries's avatar
 
Dries committed
440
 */
441
function drupal_set_message($message = NULL, $type = 'status', $repeat = FALSE) {
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
  if (isset($message)) {
    if (!isset($_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type] = array();
    }

    // Convert strings which are safe to the simplest Markup objects.
    if (!($message instanceof Markup) && $message instanceof MarkupInterface) {
      $message = Markup::create((string) $message);
    }

    // Do not use strict type checking so that equivalent string and
    // MarkupInterface objects are detected.
    if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type][] = $message;
    }

    // Mark this page as being uncacheable.
    \Drupal::service('page_cache_kill_switch')->trigger();
  }

  // Messages not set when DB connection fails.
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
464 465
}

Dries's avatar
 
Dries committed
466
/**
467
 * Returns all messages that have been set with drupal_set_message().
Dries's avatar
 
Dries committed
468
 *
469 470 471 472 473 474 475 476 477 478 479
 * @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.
480
 *
481
 * @return array
482 483 484 485
 *   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
486
 *   drupal_set_message() for the array structure of individual messages.
487 488
 *
 * @see drupal_set_message()
489
 * @see status-messages.html.twig
Dries's avatar
 
Dries committed
490
 */
491
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
492
  if ($messages = drupal_set_message()) {
493
    if ($type) {
494
      if ($clear_queue) {
495
        unset($_SESSION['messages'][$type]);
496
      }
497 498 499
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
500 501
    }
    else {
502
      if ($clear_queue) {
503
        unset($_SESSION['messages']);
504
      }
505 506
      return $messages;
    }
507
  }
508
  return array();
509 510
}

511
/**
512
 * Returns the time zone of the current user.
513 514
 */
function drupal_get_user_timezone() {
515
  $user = \Drupal::currentUser();
516
  $config = \Drupal::config('system.date');
517

518
  if ($user && $config->get('timezone.user.configurable') && $user->isAuthenticated() && $user->getTimezone()) {
519
    return $user->getTimezone();
520 521
  }
  else {
522 523
    // Ignore PHP strict notice if time zone has not yet been set in the php.ini
    // configuration.
524
    $config_data_default_timezone = $config->get('timezone.default');
525
    return !empty($config_data_default_timezone) ? $config_data_default_timezone : @date_default_timezone_get();
526 527 528
  }
}

529
/**
530
 * Provides custom PHP error handling.
531 532 533 534 535 536 537 538 539 540
 *
 * @param $error_level
 *   The level of the error raised.
 * @param $message
 *   The error message.
 * @param $filename
 *   The filename that the error was raised in.
 * @param $line
 *   The line number the error was raised at.
 * @param $context
541 542
 *   An array that points to the active symbol table at the point the error
 *   occurred.
543 544
 */
function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
545
  require_once __DIR__ . '/errors.inc';
546 547 548 549
  _drupal_error_handler_real($error_level, $message, $filename, $line, $context);
}

/**
550
 * Provides custom PHP exception handling.
551 552 553 554 555
 *
 * Uncaught exceptions are those not enclosed in a try/catch block. They are
 * always fatal: the execution of the script will stop as soon as the exception
 * handler exits.
 *
556
 * @param \Exception|\Throwable $exception
557 558 559
 *   The exception object that was thrown.
 */
function _drupal_exception_handler($exception) {
560
  require_once __DIR__ . '/errors.inc';
561 562 563

  try {
    // Log the message to the watchdog and return an error page to the user.
564
    _drupal_log_error(Error::decodeException($exception), TRUE);
565
  }
566 567 568 569
  // PHP 7 introduces Throwable, which covers both Error and
  // Exception throwables.
  catch (\Throwable $error) {
    _drupal_exception_handler_additional($exception, $error);
570
  }
571
  // In order to be compatible with PHP 5 we also catch regular Exceptions.
572
  catch (\Exception $exception2) {
573 574 575 576 577 578 579
    _drupal_exception_handler_additional($exception, $exception2);
  }
}

/**
 * Displays any additional errors caught while handling an exception.
 *
580
 * @param \Exception|\Throwable $exception
581
 *   The first exception object that was thrown.
582
 * @param \Exception|\Throwable $exception2
583 584 585 586 587 588 589 590 591 592
 *   The second exception object that was thrown.
 */
function _drupal_exception_handler_additional($exception, $exception2) {
  // Another uncaught exception was thrown while handling the first one.
  // If we are displaying errors, then do so with no possibility of a further
  // uncaught exception being thrown.
  if (error_displayable()) {
    print '<h1>Additional uncaught exception thrown while handling exception.</h1>';
    print '<h2>Original</h2><p>' . Error::renderExceptionSafe($exception) . '</p>';
    print '<h2>Additional</h2><p>' . Error::renderExceptionSafe($exception2) . '</p><hr />';
593
  }
594 595
}

596
/**
597
 * Returns the test prefix if this is an internal request from SimpleTest.
598
 *
599
 * @param string $new_prefix
600
 *   Internal use only. A new prefix to be stored.
601
 *
602
 * @return string|FALSE
603 604 605
 *   Either the simpletest prefix (the string "simpletest" followed by any
 *   number of digits) or FALSE if the user agent does not contain a valid
 *   HMAC and timestamp.
606
 */
607
function drupal_valid_test_ua($new_prefix = NULL) {
608 609
  static $test_prefix;

610 611 612
  if (isset($new_prefix)) {
    $test_prefix = $new_prefix;
  }
613 614 615
  if (isset($test_prefix)) {
    return $test_prefix;
  }
616 617 618
  // Unless the below User-Agent and HMAC validation succeeds, we are not in
  // a test environment.
  $test_prefix = FALSE;
619

620 621 622 623 624
  // A valid Simpletest request will contain a hashed and salted authentication
  // code. Check if this code is present in a cookie or custom user agent
  // string.
  $http_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : NULL;
  $user_agent = isset($_COOKIE['SIMPLETEST_USER_AGENT']) ? $_COOKIE['SIMPLETEST_USER_AGENT'] : $http_user_agent;
625
  if (isset($user_agent) && preg_match("/^(simpletest\d+):(.+):(.+):(.+)$/", $user_agent, $matches)) {
626
    list(, $prefix, $time, $salt, $hmac) = $matches;
627
    $check_string = $prefix . ':' . $time . ':' . $salt;
628 629 630 631 632 633 634 635 636 637 638 639 640
    // Read the hash salt prepared by drupal_generate_test_ua().
    // This function is called before settings.php is read and Drupal's error
    // handlers are set up. While Drupal's error handling may be properly
    // configured on production sites, the server's PHP error_reporting may not.
    // Ensure that no information leaks on production sites.
    $key_file = DRUPAL_ROOT . '/sites/simpletest/' . substr($prefix, 10) . '/.htkey';
    if (!is_readable($key_file)) {
      header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
      exit;
    }
    $private_key = file_get_contents($key_file);
    // The file properties add more entropy not easily accessible to others.
    $key = $private_key . filectime(__FILE__) . fileinode(__FILE__);
641
    $time_diff = REQUEST_TIME - $time;
642
    $test_hmac = Crypt::hmacBase64($check_string, $key);
643 644
    // Since we are making a local request a 5 second time window is allowed,
    // and the HMAC must match.
645
    if ($time_diff >= 0 && $time_diff <= 5 && $hmac === $test_hmac) {
646 647 648
      $test_prefix = $prefix;
    }
  }
649
  return $test_prefix;
650 651 652
}

/**
653
 * Generates a user agent string with a HMAC and timestamp for simpletest.
654 655
 */
function drupal_generate_test_ua($prefix) {
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
  static $key, $last_prefix;

  if (!isset($key) || $last_prefix != $prefix) {
    $last_prefix = $prefix;
    $key_file = DRUPAL_ROOT . '/sites/simpletest/' . substr($prefix, 10) . '/.htkey';
    // When issuing an outbound HTTP client request from within an inbound test
    // request, then the outbound request has to use the same User-Agent header
    // as the inbound request. A newly generated private key for the same test
    // prefix would invalidate all subsequent inbound requests.
    // @see \Drupal\Core\Http\Plugin\SimpletestHttpRequestSubscriber
    if (DRUPAL_TEST_IN_CHILD_SITE && $parent_prefix = drupal_valid_test_ua()) {
      if ($parent_prefix != $prefix) {
        throw new \RuntimeException("Malformed User-Agent: Expected '$parent_prefix' but got '$prefix'.");
      }
      // If the file is not readable, a PHP warning is expected in this case.
      $private_key = file_get_contents($key_file);
    }
    else {
      // Generate and save a new hash salt for a test run.
      // Consumed by drupal_valid_test_ua() before settings.php is loaded.
676
      $private_key = Crypt::randomBytesBase64(55);
677 678 679 680
      file_put_contents($key_file, $private_key);
    }
    // The file properties add more entropy not easily accessible to others.
    $key = $private_key . filectime(__FILE__) . fileinode(__FILE__);
681
  }
682 683
  // Generate a moderately secure HMAC based on the database credentials.
  $salt = uniqid('', TRUE);
684 685
  $check_string = $prefix . ':' . time() . ':' . $salt;
  return $check_string . ':' . Crypt::hmacBase64($check_string, $key);
686 687
}

688
/**
689 690 691
 * Enables use of the theme system without requiring database access.
 *
 * Loads and initializes the theme system for site installs, updates and when
692
 * the site is in maintenance mode. This also applies when the database fails.
693 694
 *
 * @see _drupal_maintenance_theme()
695 696
 */
function drupal_maintenance_theme() {
697
  require_once __DIR__ . '/theme.maintenance.inc';
698
  _drupal_maintenance_theme();
699
}
700

701
/**
702
 * Returns TRUE if a Drupal installation is currently being attempted.
703 704
 */
function drupal_installation_attempted() {
705 706 707 708 709 710
  // This cannot rely on the MAINTENANCE_MODE constant, since that would prevent
  // tests from using the non-interactive installer, in which case Drupal
  // only happens to be installed within the same request, but subsequently
  // executed code does not involve the installer at all.
  // @see install_drupal()
  return isset($GLOBALS['install_state']) && empty($GLOBALS['install_state']['installation_finished']);
711 712
}

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
/**
 * Gets the name of the currently active installation profile.
 *
 * When this function is called during Drupal's initial installation process,
 * the name of the profile that's about to be installed is stored in the global
 * installation state. At all other times, the "install_profile" setting will be
 * available in settings.php.
 *
 * @return string|null $profile
 *   The name of the installation profile or NULL if no installation profile is
 *   currently active. This is the case for example during the first steps of
 *   the installer or during unit tests.
 */
function drupal_get_profile() {
  global $install_state;

  if (drupal_installation_attempted()) {
    // If the profile has been selected return it.
    if (isset($install_state['parameters']['profile'])) {
      $profile = $install_state['parameters']['profile'];
    }
    else {
      $profile = NULL;
    }
  }
  else {
    // Fall back to NULL, if there is no 'install_profile' setting.
    $profile = Settings::get('install_profile');
  }

  return $profile;
}

746 747 748 749 750 751 752 753 754
/**
 * Registers an additional namespace.
 *
 * @param string $name
 *   The namespace component to register; e.g., 'node'.
 * @param string $path
 *   The relative path to the Drupal component in the filesystem.
 */
function drupal_classloader_register($name, $path) {
755
  $loader = \Drupal::service('class_loader');
756
  $loader->addPsr4('Drupal\\' . $name . '\\', \Drupal::root() . '/' . $path . '/src');
757 758
}

759
/**
760
 * Provides central static variable storage.
761
 *
762 763 764 765 766 767 768 769 770
 * All functions requiring a static variable to persist or cache data within
 * a single page request are encouraged to use this function unless it is
 * absolutely certain that the static variable will not need to be reset during
 * the page request. By centralizing static variable storage through this
 * function, other functions can rely on a consistent API for resetting any
 * other function's static variables.
 *
 * Example:
 * @code
771 772 773
 * function example_list($field = 'default') {
 *   $examples = &drupal_static(__FUNCTION__);
 *   if (!isset($examples)) {
774 775
 *     // If this function is being called for the first time after a reset,
 *     // query the database and execute any other code needed to retrieve
776
 *     // information.
777 778
 *     ...
 *   }
779
 *   if (!isset($examples[$field])) {
780 781
 *     // If this function is being called for the first time for a particular
 *     // index field, then execute code needed to index the information already
782
 *     // available in $examples by the desired field.
783 784 785 786 787
 *     ...
 *   }
 *   // Subsequent invocations of this function for a particular index field
 *   // skip the above two code blocks and quickly return the already indexed
 *   // information.
788
 *   return $examples[$field];
789
 * }
790 791 792 793
 * function examples_admin_overview() {
 *   // When building the content for the overview page, make sure to get
 *   // completely fresh information.
 *   drupal_static_reset('example_list');
794 795 796 797 798 799 800 801 802 803 804 805 806 807
 *   ...
 * }
 * @endcode
 *
 * In a few cases, a function can have certainty that there is no legitimate
 * use-case for resetting that function's static variable. This is rare,
 * because when writing a function, it's hard to forecast all the situations in
 * which it will be used. A guideline is that if a function's static variable
 * does not depend on any information outside of the function that might change
 * during a single page request, then it's ok to use the "static" keyword
 * instead of the drupal_static() function.
 *
 * Example:
 * @code
808 809 810 811
 * function mymodule_log_stream_handle($new_handle = NULL) {
 *   static $handle;
 *   if (isset($new_handle)) {
 *     $handle = $new_handle;
812
 *   }
813
 *   return $handle;
814 815 816 817 818 819 820
 * }
 * @endcode
 *
 * In a few cases, a function needs a resettable static variable, but the
 * function is called many times (100+) during a single page request, so
 * every microsecond of execution time that can be removed from the function
 * counts. These functions can use a more cumbersome, but faster variant of
821 822 823 824 825 826 827 828 829 830 831 832 833
 * calling drupal_static(). It works by storing the reference returned by
 * drupal_static() in the calling function's own static variable, thereby
 * removing the need to call drupal_static() for each iteration of the function.
 * Conceptually, it replaces:
 * @code
 * $foo = &drupal_static(__FUNCTION__);
 * @endcode
 * with:
 * @code
 * // Unfortunately, this does not work.
 * static $foo = &drupal_static(__FUNCTION__);
 * @endcode
 * However, the above line of code does not work, because PHP only allows static
834
 * variables to be initialized by literal values, and does not allow static
835
 * variables to be assigned to references.
836 837
 * - http://php.net/manual/language.variables.scope.php#language.variables.scope.static
 * - http://php.net/manual/language.variables.scope.php#language.variables.scope.references
838
 * The example below shows the syntax needed to work around both limitations.
839
 * For benchmarks and more information, see https://www.drupal.org/node/619666.
840 841 842
 *
 * Example:
 * @code
843
 * function example_default_format_type() {
844
 *   // Use the advanced drupal_static() pattern, since this is called very often.
845 846
 *   static $drupal_static_fast;
 *   if (!isset($drupal_static_fast)) {
847
 *     $drupal_static_fast['format_type'] = &drupal_static(__FUNCTION__);
848
 *   }
849
 *   $format_type = &$drupal_static_fast['format_type'];
850 851 852 853
 *   ...
 * }
 * @endcode
 *
854 855 856
 * @param $name
 *   Globally unique name for the variable. For a function with only one static,
 *   variable, the function name (e.g. via the PHP magic __FUNCTION__ constant)
857
 *   is recommended. For a function with multiple static variables add a
858 859 860 861
 *   distinguishing suffix to the function name for each one.
 * @param $default_value
 *   Optional default value.
 * @param $reset
862 863 864
 *   TRUE to reset one or all variables(s). This parameter is only used
 *   internally and should not be passed in; use drupal_static_reset() instead.
 *   (This function's return value should not be used when TRUE is passed in.)
865 866
 *
 * @return
867
 *   Returns a variable by reference.
868 869
 *
 * @see drupal_static_reset()
870 871
 */
function &drupal_static($name, $default_value = NULL, $reset = FALSE) {
872
  static $data = array(), $default = array();
873 874 875 876 877
  // First check if dealing with a previously defined static variable.
  if (isset($data[$name]) || array_key_exists($name, $data)) {
    // Non-NULL $name and both $data[$name] and $default[$name] statics exist.
    if ($reset) {
      // Reset pre-existing static variable to its default value.
878
      $data[$name] = $default[$name];
879
    }
880 881 882 883 884
    return $data[$name];
  }
  // Neither $data[$name] nor $default[$name] static variables exist.
  if (isset($name)) {
    if ($reset) {
885 886 887
      // Reset was called before a default is set and yet a variable must be
      // returned.
      return $data;
888
    }
889
    // First call with new non-NULL $name. Initialize a new static variable.
890
    $default[$name] = $data[$name] = $default_value;
891 892 893 894 895 896 897
    return $data[$name];
  }
  // Reset all: ($name == NULL). This needs to be done one at a time so that
  // references returned by earlier invocations of drupal_static() also get
  // reset.
  foreach ($default as $name => $value) {
    $data[$name] = $value;
898
  }
899 900 901
  // As the function returns a reference, the return should always be a
  // variable.
  return $data;
902 903 904
}

/**
905
 * Resets one or all centrally stored static variable(s).
906 907 908
 *
 * @param $name
 *   Name of the static variable to reset. Omit to reset all variables.
909 910
 *   Resetting all variables should only be used, for example, for running
 *   unit tests with a clean environment.
911 912 913 914
 */
function drupal_static_reset($name = NULL) {
  drupal_static($name, NULL, TRUE);
}
915

916 917
/**
 * Formats text for emphasized display in a placeholder inside a sentence.
918
 *
919 920 921 922 923 924 925
 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0. Use
 *   \Drupal\Component\Utility\SafeMarkup::format() or Twig's "placeholder"
 *   filter instead. Note this method should not be used to simply emphasize a
 *   string and therefore has few valid use-cases. Note also, that this method
 *   does not mark the string as safe.
 *
 * @see \Drupal\Component\Utility\SafeMarkup::format()
926
 */
927
function drupal_placeholder($text) {
928
  return '<em class="placeholder">' . Html::escape($text) . '</em>';
929
}
930 931

/**
932
 * Registers a function for execution on shutdown.
933
 *
934 935
 * Wrapper for register_shutdown_function() that catches thrown exceptions to
 * avoid "Exception thrown without a stack frame in Unknown".
936 937 938
 *
 * @param $callback
 *   The shutdown function to register.
939 940 941
 * @param ...
 *   Additional arguments to pass to the shutdown function.
 *
942 943 944 945
 * @return
 *   Array of shutdown functions to be executed.
 *
 * @see register_shutdown_function()
946
 * @ingroup php_wrappers
947
 */
948 949 950
function &drupal_register_shutdown_function($callback = NULL) {
  // We cannot use drupal_static() here because the static cache is reset during
  // batch processing, which breaks batch handling.
951 952 953 954 955 956 957 958
  static $callbacks = array();

  if (isset($callback)) {
    // Only register the internal shutdown function once.
    if (empty($callbacks)) {
      register_shutdown_function('_drupal_shutdown_function');
    }
    $args = func_get_args();
959 960
    // Remove $callback from the arguments.
    unset($args[0]);
961
    // Save callback and arguments
962
    $callbacks[] = array('callback' => $callback, 'arguments' => $args);
963 964 965 966 967
  }
  return $callbacks;
}

/**
968
 * Executes registered shutdown functions.
969 970 971 972
 */
function _drupal_shutdown_function() {
  $callbacks = &drupal_register_shutdown_function();

973 974 975 976
  // Set the CWD to DRUPAL_ROOT as it is not guaranteed to be the same as it
  // was in the normal context of execution.
  chdir(DRUPAL_ROOT);

977 978 979 980 981
  try {
    while (list($key, $callback) = each($callbacks)) {
      call_user_func_array($callback['callback'], $callback['arguments']);
    }
  }
982 983 984 985
  // PHP 7 introduces Throwable, which covers both Error and
  // Exception throwables.
  catch (\Throwable $error) {
    _drupal_shutdown_function_handle_exception($error);