bootstrap.inc 35.8 KB
Newer Older
1
<?php
2

3 4 5 6
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
7

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\Logger\RfcLogLevel;
13 14
use Drupal\Core\Render\Markup;
use Drupal\Component\Render\MarkupInterface;
15
use Drupal\Core\Test\TestDatabase;
16
use Drupal\Core\Session\AccountInterface;
17
use Drupal\Core\Site\Settings;
18
use Drupal\Core\Utility\Error;
19
use Drupal\Core\StringTranslation\TranslatableMarkup;
20

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

/**
 * Minimum recommended value of PHP memory_limit.
28
 *
29 30 31
 * 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.
32
 */
33
const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '64M';
34

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

55 56
/**
 * Role ID for anonymous users; should match what's in the "role" table.
57 58 59 60
 *
 * @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.
61
 */
62
const DRUPAL_ANONYMOUS_RID = AccountInterface::ANONYMOUS_ROLE;
63 64 65

/**
 * Role ID for authenticated users; should match what's in the "role" table.
66 67 68 69
 *
 * @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.
70
 */
71
const DRUPAL_AUTHENTICATED_RID = AccountInterface::AUTHENTICATED_ROLE;
72

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

78
/**
79
 * Time of the current request in seconds elapsed since the Unix Epoch.
80
 *
81 82 83 84 85 86
 * 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
87 88 89
 *
 * @deprecated in Drupal 8.3.0, will be removed before Drupal 9.0.0.
 *   Use \Drupal::time()->getRequestTime();
90
 */
91
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
92

93 94 95
/**
 * Regular expression to match PHP function names.
 *
96
 * @see http://php.net/manual/language.functions.php
97
 */
98
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
99

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

110 111 112 113 114 115 116
/**
 * $config_directories key for sync directory.
 *
 * @see config_get_config_directory()
 */
const CONFIG_SYNC_DIRECTORY = 'sync';

117 118 119
/**
 * $config_directories key for staging directory.
 *
120
 * @see config_get_config_directory()
121 122 123 124
 * @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.
125 126 127
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

128 129 130 131 132 133 134
/**
 * Defines the root directory of the Drupal installation.
 *
 * This strips two levels of directories off the current directory.
 */
define('DRUPAL_ROOT', dirname(dirname(__DIR__)));

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

153 154 155 156 157
  // @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;
  }

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

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

201 202 203 204 205 206 207 208
  // 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';
  }

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

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

243 244 245
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
246 247
}

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
/**
 * 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));
}

265
/**
266
 * Translates a string to the current language or to a given language.
267
 *
268
 * In order for strings to be localized, make them available in one of the ways
269 270 271 272
 * 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.
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
 *
 * 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
289 290
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source string
291 292
 *     belongs to. See the @link i18n Internationalization topic @endlink for
 *     more information about string contexts.
293
 *
294
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
295 296 297 298 299
 *   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()
300 301
 *
 * @ingroup sanitization
302 303
 */
function t($string, array $args = array(), array $options = array()) {
304
  return new TranslatableMarkup($string, $args, $options);
305 306 307
}

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

Gábor Hojtsy's avatar
Gábor Hojtsy committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
/**
 * 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.
 *
337 338
 * 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
339 340 341
 *
 * @param $text
 *   The text to check.
342
 *
343
 * @return bool
Gábor Hojtsy's avatar
Gábor Hojtsy committed
344
 *   TRUE if the text is valid UTF-8, FALSE if not.
345 346
 *
 * @see \Drupal\Component\Utility\Unicode::validateUtf8()
347 348 349
 *
 * @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
350 351
 */
function drupal_validate_utf8($text) {
352
  return Unicode::validateUtf8($text);
Dries's avatar
Dries committed
353 354
}

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

380 381
  // Use a default value if $message is not set.
  if (empty($message)) {
382
    $message = '%type: @message in %function (line %line of %file).';
383 384 385 386 387 388 389 390 391
  }

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

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

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

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

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

516
/**
517
 * Returns the time zone of the current user.
518 519
 */
function drupal_get_user_timezone() {
520
  $user = \Drupal::currentUser();
521
  $config = \Drupal::config('system.date');
522

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

534
/**
535
 * Provides custom PHP error handling.
536 537 538 539 540 541 542 543 544 545
 *
 * @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
546 547
 *   An array that points to the active symbol table at the point the error
 *   occurred.
548 549
 */
function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
550
  require_once __DIR__ . '/errors.inc';
551 552 553 554
  _drupal_error_handler_real($error_level, $message, $filename, $line, $context);
}

/**
555
 * Provides custom PHP exception handling.
556 557 558 559 560
 *
 * 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.
 *
561
 * @param \Exception|\Throwable $exception
562 563 564
 *   The exception object that was thrown.
 */
function _drupal_exception_handler($exception) {
565
  require_once __DIR__ . '/errors.inc';
566 567 568

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

/**
 * Displays any additional errors caught while handling an exception.
 *
585
 * @param \Exception|\Throwable $exception
586
 *   The first exception object that was thrown.
587
 * @param \Exception|\Throwable $exception2
588 589 590 591 592 593 594 595 596 597
 *   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 />';
598
  }
599 600
}

601
/**
602
 * Returns the test prefix if this is an internal request from SimpleTest.
603
 *
604
 * @param string $new_prefix
605
 *   Internal use only. A new prefix to be stored.
606
 *
607
 * @return string|false
608 609 610
 *   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.
611
 */
612
function drupal_valid_test_ua($new_prefix = NULL) {
613 614
  static $test_prefix;

615 616 617
  if (isset($new_prefix)) {
    $test_prefix = $new_prefix;
  }
618 619 620
  if (isset($test_prefix)) {
    return $test_prefix;
  }
621 622 623
  // Unless the below User-Agent and HMAC validation succeeds, we are not in
  // a test environment.
  $test_prefix = FALSE;
624

625 626 627 628 629
  // 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;
630
  if (isset($user_agent) && preg_match("/^simple(\w+\d+):(.+):(.+):(.+)$/", $user_agent, $matches)) {
631
    list(, $prefix, $time, $salt, $hmac) = $matches;
632
    $check_string = $prefix . ':' . $time . ':' . $salt;
633 634 635 636 637
    // 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.
638 639
    $test_db = new TestDatabase($prefix);
    $key_file = DRUPAL_ROOT . '/' . $test_db->getTestSitePath() . '/.htkey';
640 641 642 643 644 645 646
    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__);
647
    $time_diff = REQUEST_TIME - $time;
648
    $test_hmac = Crypt::hmacBase64($check_string, $key);
649
    // Since we are making a local request a 600 second time window is allowed,
650
    // and the HMAC must match.
651
    if ($time_diff >= 0 && $time_diff <= 600 && $hmac === $test_hmac) {
652 653
      $test_prefix = $prefix;
    }
654 655 656 657
    else {
      header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden (SIMPLETEST_USER_AGENT invalid)');
      exit;
    }
658
  }
659
  return $test_prefix;
660 661 662
}

/**
663
 * Generates a user agent string with a HMAC and timestamp for simpletest.
664 665
 */
function drupal_generate_test_ua($prefix) {
666 667 668 669
  static $key, $last_prefix;

  if (!isset($key) || $last_prefix != $prefix) {
    $last_prefix = $prefix;
670 671
    $test_db = new TestDatabase($prefix);
    $key_file = DRUPAL_ROOT . '/' . $test_db->getTestSitePath() . '/.htkey';
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
    // 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.
687
      $private_key = Crypt::randomBytesBase64(55);
688 689 690 691
      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__);
692
  }
693 694
  // Generate a moderately secure HMAC based on the database credentials.
  $salt = uniqid('', TRUE);
695
  $check_string = $prefix . ':' . time() . ':' . $salt;
696
  return 'simple' . $check_string . ':' . Crypt::hmacBase64($check_string, $key);
697 698
}

699
/**
700 701 702
 * Enables use of the theme system without requiring database access.
 *
 * Loads and initializes the theme system for site installs, updates and when
703
 * the site is in maintenance mode. This also applies when the database fails.
704 705
 *
 * @see _drupal_maintenance_theme()
706 707
 */
function drupal_maintenance_theme() {
708
  require_once __DIR__ . '/theme.maintenance.inc';
709
  _drupal_maintenance_theme();
710
}
711

712
/**
713
 * Returns TRUE if a Drupal installation is currently being attempted.
714 715
 */
function drupal_installation_attempted() {
716 717 718 719 720 721
  // 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']);
722 723
}

724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
/**
 * 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;
}

757 758 759 760 761 762 763 764 765
/**
 * 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) {
766
  $loader = \Drupal::service('class_loader');
767
  $loader->addPsr4('Drupal\\' . $name . '\\', \Drupal::root() . '/' . $path . '/src');
768 769
}

770
/**
771
 * Provides central static variable storage.
772
 *
773 774 775 776 777 778 779 780 781
 * 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
782 783 784
 * function example_list($field = 'default') {
 *   $examples = &drupal_static(__FUNCTION__);
 *   if (!isset($examples)) {
785 786
 *     // If this function is being called for the first time after a reset,
 *     // query the database and execute any other code needed to retrieve
787
 *     // information.
788 789
 *     ...
 *   }
790
 *   if (!isset($examples[$field])) {
791 792
 *     // If this function is being called for the first time for a particular
 *     // index field, then execute code needed to index the information already
793
 *     // available in $examples by the desired field.
794 795 796 797 798
 *     ...
 *   }
 *   // Subsequent invocations of this function for a particular index field
 *   // skip the above two code blocks and quickly return the already indexed
 *   // information.
799
 *   return $examples[$field];
800
 * }
801 802 803 804
 * function examples_admin_overview() {
 *   // When building the content for the overview page, make sure to get
 *   // completely fresh information.
 *   drupal_static_reset('example_list');
805 806 807 808 809 810 811 812 813 814 815 816 817 818
 *   ...
 * }
 * @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
819 820 821 822
 * function mymodule_log_stream_handle($new_handle = NULL) {
 *   static $handle;
 *   if (isset($new_handle)) {
 *     $handle = $new_handle;
823
 *   }
824
 *   return $handle;
825 826 827 828 829 830 831
 * }
 * @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
832 833 834 835 836 837 838 839 840 841 842 843 844
 * 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
845
 * variables to be initialized by literal values, and does not allow static
846
 * variables to be assigned to references.
847 848
 * - http://php.net/manual/language.variables.scope.php#language.variables.scope.static
 * - http://php.net/manual/language.variables.scope.php#language.variables.scope.references
849
 * The example below shows the syntax needed to work around both limitations.
850
 * For benchmarks and more information, see https://www.drupal.org/node/619666.
851 852 853
 *
 * Example:
 * @code
854
 * function example_default_format_type() {
855
 *   // Use the advanced drupal_static() pattern, since this is called very often.
856 857
 *   static $drupal_static_fast;
 *   if (!isset($drupal_static_fast)) {
858
 *     $drupal_static_fast['format_type'] = &drupal_static(__FUNCTION__);
859
 *   }
860
 *   $format_type = &$drupal_static_fast['format_type'];
861 862 863 864
 *   ...
 * }
 * @endcode
 *
865 866 867
 * @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)
868
 *   is recommended. For a function with multiple static variables add a
869 870 871 872
 *   distinguishing suffix to the function name for each one.
 * @param $default_value
 *   Optional default value.
 * @param $reset
873 874 875
 *   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.)
876 877
 *
 * @return
878
 *   Returns a variable by reference.
879 880
 *
 * @see drupal_static_reset()
881 882
 */
function &drupal_static($name, $default_value = NULL, $reset = FALSE) {
883
  static $data = array(), $default = array();
884 885 886 887 888
  // 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.
889
      $data[$name] = $default[$name];
890
    }
891 892 893 894 895
    return $data[$name];
  }
  // Neither $data[$name] nor $default[$name] static variables exist.
  if (isset($name)) {
    if ($reset) {
896 897 898
      // Reset was called before a default is set and yet a variable must be
      // returned.
      return $data;
899
    }
900
    // First call with new non-NULL $name. Initialize a new static variable.
901
    $default[$name] = $data[$name] = $default_value;
902 903 904 905 906 907 908
    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;
909
  }
910 911 912
  // As the function returns a reference, the return should always be a
  // variable.
  return $data;
913 914 915
}

/**
916
 * Resets one or all centrally stored static variable(s).
917 918 919
 *
 * @param $name
 *   Name of the static variable to reset. Omit to reset all variables.
920 921
 *   Resetting all variables should only be used, for example, for running
 *   unit tests with a clean environment.
922 923 924 925
 */
function drupal_static_reset($name = NULL) {
  drupal_static($name, NULL, TRUE);
}
926

927 928
/**
 * Formats text for emphasized display in a placeholder inside a sentence.
929
 *
930 931 932 933 934 935 936
 * @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()
937
 */
938
function drupal_placeholder($text) {
939
  return '<em class="placeholder">' . Html::escape($text) . '</em>';
940
}
941 942

/**
943
 * Registers a function for execution on shutdown.
944
 *
945 946
 * Wrapper for register_shutdown_function() that catches thrown exceptions to
 * avoid "Exception thrown without a stack frame in Unknown".
947 948 949
 *
 * @param $callback
 *   The shutdown function to register.
950 951 952
 * @param ...
 *   Additional arguments to pass to the shutdown function.
 *
953 954 955 956
 * @return
 *   Array of shutdown functions to be executed.
 *
 * @see register_shutdown_function()
957
 * @ingroup php_wrappers
958
 */
959 960 961
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.
962 963 964 965 966 967 968 969
  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();
970 971
    // Remove $callback from the arguments.
    unset($args[0]);
972
    // Save callback and arguments
973
    $callbacks[] = array('callback' => $callback, 'arguments' => $args);
974 975 976 977 978
  }
  return $callbacks;
}

/**
979
 * Executes registered shutdown functions.
980 981 982 983
 */
function _drupal_shutdown_function() {
  $callbacks = &drupal_register_shutdown_function();

984 985 986 987
  // 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);

988 989 990 991 992
  try {
    while (list($key, $callback) = each($callbacks)) {
      call_user_func_array($callback['callback'], $callback['arguments']);
    }
  }
993 994 995 996
  // PHP 7 introduces Throwable, which covers both Error and
  // Exception throwables.
  catch (\Throwable $error) {
    _drupal_shutdown_function_handle_exception($error);
997
  }
998
  // In order to be compatible with PHP 5 we also catch regular Exceptions.
999
  catch (\Exception $exception) {
1000 1001 1002 1003 1004 1005 1006
    _drupal_shutdown_function_handle_exception($exception);
  }
}

/**
 * Displays and logs any errors that may happen during shutdown.
 *
1007
 * @param \Exception|\Throwable $exception
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
 *   The exception object that was thrown.
 *
 * @see _drupal_shutdown_function()
 */
function _drupal_shutdown_function_handle_exception($exception) {
  // If using PHP-FPM then fastcgi_finish_request() will have been fired
  // preventing further output to the browser.
  if (!function_exists('fastcgi_finish_request')) {
    // If we are displaying errors, then do so with no possibility of a
    // further uncaught exception being thrown.
    require_once __DIR__ . '/errors.inc';
    if (error_displayable()) {
      print '<h1>Uncaught exception thrown in shutdown function.</h1>';
      print '<p>' . Error::renderExceptionSafe($exception) . '</p><hr />';
1022
    }
1023
  }
1024
  error_log($exception);
1025
}