bootstrap.inc 42.9 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\Datetime\DateTimePlus;
8
use Drupal\Component\Utility\Crypt;
9
use Drupal\Component\Utility\Environment;
10
use Drupal\Component\Utility\SafeMarkup;
11
use Drupal\Component\Utility\String;
12
use Drupal\Component\Utility\Unicode;
13
use Drupal\Core\DrupalKernel;
14
use Drupal\Core\Extension\ExtensionDiscovery;
15
use Drupal\Core\Logger\RfcLogLevel;
16
use Drupal\Core\Site\Settings;
17
use Drupal\Core\Utility\Error;
18
use Symfony\Component\ClassLoader\ApcClassLoader;
19
use Symfony\Component\HttpFoundation\Request;
20
use Symfony\Component\HttpFoundation\Response;
21
use Drupal\Core\Language\LanguageInterface;
22

23 24
/**
 * Minimum supported version of PHP.
25
 */
26
const DRUPAL_MINIMUM_PHP = '5.4.5';
27 28 29

/**
 * Minimum recommended value of PHP memory_limit.
30 31 32
 *
 * @todo Reduce the memory required to install on some environments in
 *   https://www.drupal.org/node/2289201 and then decrease this limit.
33
 */
34
const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '64M';
35

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

56 57
/**
 * First bootstrap phase: initialize configuration.
58 59
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
60
 */
61
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
62 63

/**
64 65 66
 * Second bootstrap phase, initialize a kernel.
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
67
 */
68
const DRUPAL_BOOTSTRAP_KERNEL = 1;
69 70

/**
71
 * Third bootstrap phase: load code for subsystems and modules.
72 73
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
74
 */
75
const DRUPAL_BOOTSTRAP_CODE = 2;
76 77

/**
78
 * Final bootstrap phase: initialize language, path, theme, and modules.
79 80
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
81
 */
82
const DRUPAL_BOOTSTRAP_FULL = 3;
83

84 85 86
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
87
const DRUPAL_ANONYMOUS_RID = 'anonymous';
88 89 90 91

/**
 * Role ID for authenticated users; should match what's in the "role" table.
 */
92
const DRUPAL_AUTHENTICATED_RID = 'authenticated';
93

94 95 96 97 98
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

99
/**
100
 * Time of the current request in seconds elapsed since the Unix Epoch.
101
 *
102 103 104 105 106 107
 * 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
108
 */
109
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
110

111 112 113
/**
 * Regular expression to match PHP function names.
 *
114
 * @see http://php.net/manual/language.functions.php
115
 */
116
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
117

118 119 120
/**
 * $config_directories key for active directory.
 *
121
 * @see config_get_config_directory()
122 123 124 125 126 127
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
128
 * @see config_get_config_directory()
129 130 131
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

132 133 134 135 136 137 138
/**
 * Defines the root directory of the Drupal installation.
 *
 * This strips two levels of directories off the current directory.
 */
define('DRUPAL_ROOT', dirname(dirname(__DIR__)));

Dries's avatar
 
Dries committed
139
/**
140
 * Returns the appropriate configuration directory.
Dries's avatar
 
Dries committed
141
 *
142
 * @param bool $require_settings
143 144 145 146
 *   Only configuration directories with an existing settings.php file
 *   will be recognized. Defaults to TRUE. During initial installation,
 *   this is set to FALSE so that Drupal can detect a matching directory,
 *   then create a new settings.php file in it.
147
 * @param bool $reset
148
 *   Force a full search for matching directories even if one had been
149
 *   found previously. Defaults to FALSE.
150 151 152
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   (optional) The current request. Defaults to \Drupal::request() or a new
 *   request created from globals.
153
 *
154 155
 * @return string
 *   The path of the matching directory.@see default.settings.php
156
 *
157 158 159 160 161 162 163 164 165 166 167 168 169 170
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\Core\DrupalKernel::getSitePath() instead. If the kernel is
 *   unavailable or the site path needs to be recalculated then
 *   Drupal\Core\DrupalKernel::findSitePath() can be used.
 */
function conf_path($require_settings = TRUE, $reset = FALSE, Request $request = NULL) {
  if (!isset($request)) {
    if (\Drupal::hasRequest()) {
      $request = \Drupal::request();
    }
    // @todo Remove once external CLI scripts (Drush) are updated.
    else {
      $request = Request::createFromGlobals();
    }
171
  }
172 173
  if (\Drupal::hasService('kernel')) {
    $site_path = \Drupal::service('kernel')->getSitePath();
174
  }
175 176
  if (!isset($site_path) || empty($site_path)) {
    $site_path = DrupalKernel::findSitePath($request, $require_settings);
Dries's avatar
 
Dries committed
177
  }
178
  return $site_path;
Dries's avatar
 
Dries committed
179
}
180
/**
181 182 183 184 185
 * Returns the path of a configuration directory.
 *
 * @param string $type
 *   (optional) The type of config directory to return. Drupal core provides
 *   'active' and 'staging'. Defaults to CONFIG_ACTIVE_DIRECTORY.
186 187 188 189
 *
 * @return string
 *   The configuration directory path.
 */
190 191
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
192

193
  if (!empty($config_directories[$type])) {
194
    return $config_directories[$type];
195
  }
196
  throw new \Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
197 198
}

Dries's avatar
Dries committed
199
/**
200 201 202 203
 * 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
204
 *
Dries's avatar
Dries committed
205 206
 * 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
207
 * configuration. For example, a module 'foo' may legally be located
Dries's avatar
Dries committed
208 209
 * in any of these three places:
 *
210 211 212
 * core/modules/foo/foo.info.yml
 * modules/foo/foo.info.yml
 * sites/example.com/modules/foo/foo.info.yml
Dries's avatar
Dries committed
213 214 215 216
 *
 * 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
217
 * @param $type
218 219
 *   The type of the item; one of 'core', 'profile', 'module', 'theme', or
 *   'theme_engine'.
Dries's avatar
Dries committed
220
 * @param $name
221 222
 *   The name of the item for which the filename is requested. Ignored for
 *   $type 'core'.
Dries's avatar
Dries committed
223 224 225 226 227
 * @param $filename
 *   The filename of the item if it is to be set explicitly rather
 *   than by consulting the database.
 *
 * @return
228
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
229
 */
Dries's avatar
Dries committed
230
function drupal_get_filename($type, $name, $filename = NULL) {
231 232
  // The location of files will not change during the request, so do not use
  // drupal_static().
233
  static $files = array();
Dries's avatar
Dries committed
234

235 236 237 238 239 240 241 242
  // 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';
  }

243 244 245
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
246
  if ($type == 'profile') {
247
    $type = 'module';
248
  }
249
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
250 251 252
    $files[$type] = array();
  }

253
  if (isset($filename)) {
Dries's avatar
Dries committed
254 255
    $files[$type][$name] = $filename;
  }
256 257 258 259 260 261
  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')) {
262 263 264
      foreach (\Drupal::moduleHandler()->getModuleList() as $module_name => $module) {
        $files[$type][$module_name] = $module->getPathname();
      }
265 266 267 268 269
    }
    // If still unknown, retrieve the file list prepared in state by
    // system_rebuild_module_data() and system_rebuild_theme_data().
    if (!isset($files[$type][$name]) && \Drupal::hasService('state')) {
      $files[$type] += \Drupal::state()->get('system.' . $type . '.files', array());
270
    }
271
    // If still unknown, perform a filesystem scan.
272
    if (!isset($files[$type][$name])) {
273
      $listing = new ExtensionDiscovery(DRUPAL_ROOT);
274 275 276
      // Prevent an infinite recursion by this legacy function.
      if ($original_type == 'profile') {
        $listing->setProfileDirectories(array());
277
      }
278
      foreach ($listing->scan($original_type) as $extension_name => $file) {
279
        $files[$type][$extension_name] = $file->getPathname();
Dries's avatar
Dries committed
280 281 282 283
      }
    }
  }

284 285 286
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
287 288
}

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
/**
 * 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));
}

306
/**
307
 * Sets an HTTP response header for the current page.
308 309 310 311 312
 *
 * Note: When sending a Content-Type header, always include a 'charset' type,
 * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
 *
 * @param $name
313
 *   The HTTP header name, or the special 'Status' header name.
314
 * @param $value
315 316 317
 *   The HTTP header value; if equal to FALSE, the specified header is unset.
 *   If $name is 'Status', this is expected to be a status code followed by a
 *   reason phrase, e.g. "404 Not Found".
318 319
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
320
 *
321 322 323
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Symfony\Component\HttpFoundation\Response->headers->set().
 *   See https://drupal.org/node/2181523.
324
 */
325
function _drupal_add_http_header($name, $value, $append = FALSE) {
326
  // The headers as name/value pairs.
327
  $headers = &drupal_static('drupal_http_headers', array());
328

329
  $name_lower = strtolower($name);
330
  _drupal_set_preferred_header_name($name);
331

332
  if ($value === FALSE) {
333
    $headers[$name_lower] = FALSE;
334
  }
335
  elseif (isset($headers[$name_lower]) && $append) {
336 337
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
338
    $headers[$name_lower] .= ',' . $value;
339 340
  }
  else {
341
    $headers[$name_lower] = $value;
342 343 344 345
  }
}

/**
346
 * Gets the HTTP response headers for the current page.
347 348 349 350
 *
 * @param $name
 *   An HTTP header name. If omitted, all headers are returned as name/value
 *   pairs. If an array value is FALSE, the header has been unset.
351
 *
352 353 354
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
355
 *
356 357 358
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Symfony\Component\HttpFoundation\Response->headers->get().
 *   See https://drupal.org/node/2181523.
359
 */
360
function drupal_get_http_header($name = NULL) {
361
  $headers = &drupal_static('drupal_http_headers', array());
362 363 364 365 366 367 368 369 370 371
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
372 373
 * Sets the preferred name for the HTTP header.
 *
374
 * Header names are case-insensitive, but for maximum compatibility they should
375 376
 * follow "common form" (see RFC 2616, section 4.2).
 *
377 378
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
379 380 381 382 383 384 385 386 387 388
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

  if (!isset($name)) {
    return $header_names;
  }
  $header_names[strtolower($name)] = $name;
}

389
/**
390
 * Translates a string to the current language or to a given language.
391
 *
392 393 394
 * The t() function serves two purposes. First, at run-time it translates
 * user-visible text into the appropriate language. Second, various mechanisms
 * that figure out what text needs to be translated work off t() -- the text
395 396 397 398 399
 * inside t() calls is added to the database of strings to be translated.
 * These strings are expected to be in English, so the first argument should
 * always be in English. To enable a fully-translatable site, it is important
 * that all human-readable text that will be displayed on the site or sent to
 * a user is passed through the t() function, or a related function. See the
400 401 402 403
 * @link http://drupal.org/node/322729 Localization API @endlink pages for
 * more information, including recommendations on how to break up or not
 * break up strings for translation.
 *
404
 * @section sec_translating_vars Translating Variables
405 406 407 408 409 410 411 412 413
 * You should never use t() to translate variables, such as calling
 * @code t($text); @endcode, unless the text that the variable holds has been
 * passed through t() elsewhere (e.g., $text is one of several translated
 * literal strings in an array). It is especially important never to call
 * @code t($user_text); @endcode, where $user_text is some text that a user
 * entered - doing that can lead to cross-site scripting and other security
 * problems. However, you can use variable substitution in your string, to put
 * variable text such as user names or link URLs into translated text. Variable
 * substitution looks like this:
414
 * @code
415
 * $text = t("@name's blog", array('@name' => user_format_name($account)));
416
 * @endcode
417
 * Basically, you can put variables like @name into your string, and t() will
418 419
 * substitute their sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
420 421 422
 * format_string() for details about how to define variables in your string.)
 * Translators can then rearrange the string as necessary for the language
 * (e.g., in Spanish, it might be "blog de @name").
423 424 425 426
 *
 * @param $string
 *   A string containing the English string to translate.
 * @param $args
427 428 429
 *   An associative array of replacements to make after translation. Based
 *   on the first character of the key, the value is escaped and/or themed.
 *   See format_string() for details.
430
 * @param $options
431 432 433 434 435
 *   An associative array of additional options, with the following elements:
 *   - 'langcode' (defaults to the current language): The language code to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source string
 *     belongs to.
436
 *
437 438
 * @return
 *   The translated string.
439
 *
440
 * @see format_string()
441
 * @ingroup sanitization
442 443
 */
function t($string, array $args = array(), array $options = array()) {
444
  return \Drupal::translation()->translate($string, $args, $options);
445 446 447
}

/**
448 449
 * Formats a string for HTML display by replacing variable placeholders.
 *
450
 * @see \Drupal\Component\Utility\String::format()
451 452 453 454
 * @see t()
 * @ingroup sanitization
 */
function format_string($string, array $args = array()) {
455
  return String::format($string, $args);
456 457
}

Gábor Hojtsy's avatar
Gábor Hojtsy committed
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
/**
 * 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.
 *
473 474
 * 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
475 476 477
 *
 * @param $text
 *   The text to check.
478
 *
Gábor Hojtsy's avatar
Gábor Hojtsy committed
479 480
 * @return
 *   TRUE if the text is valid UTF-8, FALSE if not.
481 482
 *
 * @see \Drupal\Component\Utility\Unicode::validateUtf8()
Gábor Hojtsy's avatar
Gábor Hojtsy committed
483 484
 */
function drupal_validate_utf8($text) {
485
  return Unicode::validateUtf8($text);
Dries's avatar
Dries committed
486 487
}

Dries's avatar
 
Dries committed
488
/**
489 490 491 492
 * Returns the equivalent of Apache's $_SERVER['REQUEST_URI'] variable.
 *
 * Because $_SERVER['REQUEST_URI'] is only available on Apache, we generate an
 * equivalent using other environment variables.
493 494
 *
 * @todo The above comment is incorrect: http://drupal.org/node/1547294.
Dries's avatar
 
Dries committed
495
 */
496
function request_uri($omit_query_string = FALSE) {
497 498 499 500
  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
501
    if (isset($_SERVER['argv'][0])) {
502
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
503
    }
504
    elseif (isset($_SERVER['QUERY_STRING'])) {
505
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
506
    }
507 508 509
    else {
      $uri = $_SERVER['SCRIPT_NAME'];
    }
Dries's avatar
 
Dries committed
510
  }
511 512
  // Prevent multiple slashes to avoid cross site requests via the Form API.
  $uri = '/' . ltrim($uri, '/');
513

514
  return $omit_query_string ? strtok($uri, '?') : $uri;
Dries's avatar
 
Dries committed
515
}
Dries's avatar
Dries committed
516

517
/**
518
 * Logs an exception.
519
 *
520
 * This is a wrapper logging function which automatically decodes an exception.
521 522 523 524 525 526 527
 *
 * @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
528
 *   information about the passed-in exception is used.
529
 * @param $variables
530 531 532
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
533 534 535 536 537
 * @param $severity
 *   The severity of the message, as per RFC 3164.
 * @param $link
 *   A link to associate with the message.
 *
538
 * @see \Drupal\Core\Utility\Error::decodeException()
539
 */
540
function watchdog_exception($type, Exception $exception, $message = NULL, $variables = array(), $severity = RfcLogLevel::ERROR, $link = NULL) {
541

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
  // Use a default value if $message is not set.
  if (empty($message)) {
    // The exception message is run through
    // \Drupal\Component\Utility\String::checkPlain() by
    // \Drupal\Core\Utility\Error:decodeException().
    $message = '%type: !message in %function (line %line of %file).';
  }

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

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

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

Dries's avatar
 
Dries committed
559
/**
560
 * Sets a message to display to the user.
Dries's avatar
 
Dries committed
561
 *
562 563
 * Messages are stored in a session variable and displayed in the page template
 * via the $messages theme variable.
Dries's avatar
 
Dries committed
564
 *
565 566 567 568 569 570 571 572 573 574 575 576
 * Example usage:
 * @code
 * drupal_set_message(t('An error occurred and processing did not complete.'), 'error');
 * @endcode
 *
 * @param string $message
 *   (optional) The translated message to be displayed to the user. For
 *   consistency with other messages, it should begin with a capital letter and
 *   end with a period.
 * @param string $type
 *   (optional) The message's type. Defaults to 'status'. These values are
 *   supported:
577
 *   - 'status'
578
 *   - 'warning'
579
 *   - 'error'
580 581
 * @param bool $repeat
 *   (optional) If this is FALSE and the message is already set, then the
582
 *   message won't be repeated. Defaults to FALSE.
583 584 585
 *
 * @return array|null
 *   A multidimensional array with keys corresponding to the set message types.
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
 *   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.
607 608
 *
 * @see drupal_get_messages()
609
 * @see status-messages.html.twig
Dries's avatar
 
Dries committed
610
 */
611
function drupal_set_message($message = NULL, $type = 'status', $repeat = FALSE) {
612
  if (isset($message)) {
Dries's avatar
 
Dries committed
613 614 615 616
    if (!isset($_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type] = array();
    }

617 618 619 620 621 622
    $new = array(
      'safe' => SafeMarkup::isSafe($message),
      'message' => $message,
    );
    if ($repeat || !in_array($new, $_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type][] = $new;
623
    }
624

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

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

Dries's avatar
 
Dries committed
633
/**
634
 * Returns all messages that have been set with drupal_set_message().
Dries's avatar
 
Dries committed
635
 *
636 637 638 639 640 641 642 643 644 645 646
 * @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.
647
 *
648
 * @return array
649 650 651 652
 *   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
653
 *   drupal_set_message() for the array structure of individual messages.
654 655
 *
 * @see drupal_set_message()
656
 * @see status-messages.html.twig
Dries's avatar
 
Dries committed
657
 */
658
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
659
  if ($messages = drupal_set_message()) {
660 661 662 663 664 665 666 667
    foreach ($messages as $message_type => $message_typed_messages) {
      foreach ($message_typed_messages as $key => $message) {
        if ($message['safe']) {
          $message['message'] = SafeMarkup::set($message['message']);
        }
        $messages[$message_type][$key] = $message['message'];
      }
    }
668
    if ($type) {
669
      if ($clear_queue) {
670
        unset($_SESSION['messages'][$type]);
671
      }
672 673 674
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
675 676
    }
    else {
677
      if ($clear_queue) {
678
        unset($_SESSION['messages']);
679
      }
680 681
      return $messages;
    }
682
  }
683
  return array();
684 685
}

686
/**
687 688 689 690 691 692 693 694
 * Ensures Drupal is bootstrapped to the specified phase.
 *
 * In order to bootstrap Drupal from another PHP script, you can use this code:
 * @code
 *   require_once '/path/to/drupal/core/vendor/autoload.php';
 *   require_once '/path/to/drupal/core/includes/bootstrap.inc';
 *   drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
 * @endcode
695 696
 *
 * @param $phase
697
 *   A constant telling which phase to bootstrap to. Possible values:
698
 *   - DRUPAL_BOOTSTRAP_CONFIGURATION: Initializes configuration.
699
 *   - DRUPAL_BOOTSTRAP_KERNEL: Initializes a kernel.
700
 *
701
 * @return int
702
 *   The most recently completed phase.
703 704 705
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Interact directly with the kernel.
706
 */
707
function drupal_bootstrap($phase = NULL) {
708 709 710 711 712
  // Temporary variables used for booting later legacy phases.
  /** @var \Drupal\Core\DrupalKernel $kernel */
  static $kernel;
  static $boot_level = 0;

713
  if (isset($phase)) {
714 715
    $request = Request::createFromGlobals();
    for ($current_phase = $boot_level; $current_phase <= $phase; $current_phase++) {
716

717 718
      switch ($current_phase) {
        case DRUPAL_BOOTSTRAP_CONFIGURATION:
719 720
          $classloader = require __DIR__ . '/../vendor/autoload.php';
          $kernel = DrupalKernel::createFromRequest($request, $classloader, 'prod');
721 722
          break;

723
        case DRUPAL_BOOTSTRAP_KERNEL:
724
          $kernel->boot();
725 726
          break;

727
        case DRUPAL_BOOTSTRAP_CODE:
728
        case DRUPAL_BOOTSTRAP_FULL:
729
          $kernel->prepareLegacyRequest($request);
730 731
          break;
      }
732
    }
733
    $boot_level = $phase;
734 735
  }

736
  return \Drupal::hasContainer() ? DRUPAL_BOOTSTRAP_CODE : DRUPAL_BOOTSTRAP_CONFIGURATION;
737 738
}

739
/**
740
 * Returns the time zone of the current user.
741 742 743
 */
function drupal_get_user_timezone() {
  global $user;
744
  $config = \Drupal::config('system.date');
745

746
  if ($user && $config->get('timezone.user.configurable') && $user->isAuthenticated() && $user->getTimezone()) {
747
    return $user->getTimezone();
748 749
  }
  else {
750 751
    // Ignore PHP strict notice if time zone has not yet been set in the php.ini
    // configuration.
752
    $config_data_default_timezone = $config->get('timezone.default');
753
    return !empty($config_data_default_timezone) ? $config_data_default_timezone : @date_default_timezone_get();
754 755 756
  }
}

757
/**
758
 * Provides custom PHP error handling.
759 760 761 762 763 764 765 766 767 768
 *
 * @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
769 770
 *   An array that points to the active symbol table at the point the error
 *   occurred.
771 772
 */
function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
773
  require_once __DIR__ . '/errors.inc';
774 775 776 777
  _drupal_error_handler_real($error_level, $message, $filename, $line, $context);
}

/**
778
 * Provides custom PHP exception handling.
779 780 781 782 783 784 785 786 787
 *
 * 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.
 *
 * @param $exception
 *   The exception object that was thrown.
 */
function _drupal_exception_handler($exception) {
788
  require_once __DIR__ . '/errors.inc';
789 790 791

  try {
    // Log the message to the watchdog and return an error page to the user.
792
    _drupal_log_error(Error::decodeException($exception), TRUE);
793 794 795 796
  }
  catch (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.
797 798
    if (error_displayable()) {
      print '<h1>Additional uncaught exception thrown while handling exception.</h1>';
799 800
      print '<h2>Original</h2><p>' . Error::renderExceptionSafe($exception) . '</p>';
      print '<h2>Additional</h2><p>' . Error::renderExceptionSafe($exception2) . '</p><hr />';
801 802
    }
  }
803 804
}

805 806 807 808 809 810
/**
 * Returns the current bootstrap phase for this Drupal process.
 *
 * The current phase is the one most recently completed by drupal_bootstrap().
 *
 * @see drupal_bootstrap()
811 812
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
813 814 815 816 817
 */
function drupal_get_bootstrap_phase() {
  return drupal_bootstrap();
}

818
/**
819
 * Returns the test prefix if this is an internal request from SimpleTest.
820
 *
821
 * @param string $new_prefix
822
 *   Internal use only. A new prefix to be stored.
823
 *
824
 * @return string|FALSE
825 826 827
 *   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.
828
 */
829
function drupal_valid_test_ua($new_prefix = NULL) {
830 831
  static $test_prefix;

832 833 834
  if (isset($new_prefix)) {
    $test_prefix = $new_prefix;
  }
835 836 837
  if (isset($test_prefix)) {
    return $test_prefix;
  }
838 839 840
  // Unless the below User-Agent and HMAC validation succeeds, we are not in
  // a test environment.
  $test_prefix = FALSE;
841

842 843
  // Perform a basic check on the User-Agent HTTP request header first. Any
  // inbound request that uses the simpletest UA header needs to be validated.
844 845 846
  if (isset($_SERVER['HTTP_USER_AGENT']) && preg_match("/^(simpletest\d+);(.+);(.+);(.+)$/", $_SERVER['HTTP_USER_AGENT'], $matches)) {
    list(, $prefix, $time, $salt, $hmac) = $matches;
    $check_string =  $prefix . ';' . $time . ';' . $salt;
847 848 849 850 851 852 853 854 855 856 857 858 859
    // 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__);
860
    $time_diff = REQUEST_TIME - $time;
861
    $test_hmac = Crypt::hmacBase64($check_string, $key);
862 863
    // Since we are making a local request a 5 second time window is allowed,
    // and the HMAC must match.
864
    if ($time_diff >= 0 && $time_diff <= 5 && $hmac === $test_hmac) {
865 866 867
      $test_prefix = $prefix;
    }
  }
868
  return $test_prefix;
869 870 871
}

/**