bootstrap.inc 48.7 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: try to serve a cached page.
72 73
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
74
 */
75
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
76 77

/**
78
 * Fourth bootstrap phase: load code for subsystems and modules.
79 80
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
81
 */
82
const DRUPAL_BOOTSTRAP_CODE = 3;
83 84

/**
85
 * Final bootstrap phase: initialize language, path, theme, and modules.
86 87
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
88
 */
89
const DRUPAL_BOOTSTRAP_FULL = 4;
90

91 92 93
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
94
const DRUPAL_ANONYMOUS_RID = 'anonymous';
95 96 97 98

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

101 102 103 104 105
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

106
/**
107
 * Time of the current request in seconds elapsed since the Unix Epoch.
108
 *
109 110 111 112 113 114
 * 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
115
 */
116
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
117

118 119 120
/**
 * Regular expression to match PHP function names.
 *
121
 * @see http://php.net/manual/language.functions.php
122
 */
123
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
124

125 126 127
/**
 * $config_directories key for active directory.
 *
128
 * @see config_get_config_directory()
129 130 131 132 133 134
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
135
 * @see config_get_config_directory()
136 137 138
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

139 140 141 142 143 144 145
/**
 * 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
146
/**
147
 * Returns the appropriate configuration directory.
Dries's avatar
 
Dries committed
148
 *
149
 * @param bool $require_settings
150 151 152 153
 *   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.
154
 * @param bool $reset
155
 *   Force a full search for matching directories even if one had been
156
 *   found previously. Defaults to FALSE.
157 158 159
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   (optional) The current request. Defaults to \Drupal::request() or a new
 *   request created from globals.
160
 *
161 162
 * @return string
 *   The path of the matching directory.@see default.settings.php
163
 *
164 165 166 167 168 169 170 171 172 173 174 175 176 177
 * @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();
    }
178
  }
179 180
  if (\Drupal::hasService('kernel')) {
    $site_path = \Drupal::service('kernel')->getSitePath();
181
  }
182 183
  if (!isset($site_path) || empty($site_path)) {
    $site_path = DrupalKernel::findSitePath($request, $require_settings);
Dries's avatar
 
Dries committed
184
  }
185
  return $site_path;
Dries's avatar
 
Dries committed
186
}
187
/**
188 189 190 191 192
 * 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.
193 194 195 196
 *
 * @return string
 *   The configuration directory path.
 */
197 198
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
199

200
  if (!empty($config_directories[$type])) {
201
    return $config_directories[$type];
202
  }
203
  throw new \Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
204 205
}

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

242 243 244 245 246 247 248 249
  // 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';
  }

250 251 252
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
253
  if ($type == 'profile') {
254
    $type = 'module';
255
  }
256
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
257 258 259
    $files[$type] = array();
  }

260
  if (isset($filename)) {
Dries's avatar
Dries committed
261 262
    $files[$type][$name] = $filename;
  }
263 264 265 266 267 268
  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')) {
269 270 271
      foreach (\Drupal::moduleHandler()->getModuleList() as $module_name => $module) {
        $files[$type][$module_name] = $module->getPathname();
      }
272 273 274 275 276
    }
    // 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());
277
    }
278
    // If still unknown, perform a filesystem scan.
279
    if (!isset($files[$type][$name])) {
280 281 282 283
      $listing = new ExtensionDiscovery();
      // Prevent an infinite recursion by this legacy function.
      if ($original_type == 'profile') {
        $listing->setProfileDirectories(array());
284
      }
285
      foreach ($listing->scan($original_type) as $extension_name => $file) {
286
        $files[$type][$extension_name] = $file->getPathname();
Dries's avatar
Dries committed
287 288 289 290
      }
    }
  }

291 292 293
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
294 295
}

296 297 298 299 300 301 302 303 304 305 306 307
/**
 * Gets the page cache cid for this request.
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request for this page.
 *
 * @return string
 *   The cid for this request.
 */
function drupal_page_cache_get_cid(Request $request) {
  $cid_parts = array(
    $request->getUri(),
308
    \Drupal::service('content_negotiation')->getContentType($request),
309 310 311 312
  );
  return sha1(implode(':', $cid_parts));
}

Dries's avatar
 
Dries committed
313
/**
314
 * Retrieves the current page from the cache.
Dries's avatar
 
Dries committed
315
 *
316 317
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request for this page.
318
 *
319 320
 * @return \Symfony\Component\HttpFoundation\Response
 *   The response, if the page was found in the cache, NULL otherwise.
Dries's avatar
 
Dries committed
321
 */
322
function drupal_page_get_cache(Request $request) {
323 324 325
  $cache = \Drupal::cache('render')->get(drupal_page_cache_get_cid($request));
  if ($cache) {
    return $cache->data;
326
  }
327 328
}

329
/**
330
 * Sets an HTTP response header for the current page.
331 332 333 334 335
 *
 * 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
336
 *   The HTTP header name, or the special 'Status' header name.
337
 * @param $value
338 339 340
 *   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".
341 342
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
343
 *
344 345 346
 * @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.
347
 */
348
function _drupal_add_http_header($name, $value, $append = FALSE) {
349
  // The headers as name/value pairs.
350
  $headers = &drupal_static('drupal_http_headers', array());
351

352
  $name_lower = strtolower($name);
353
  _drupal_set_preferred_header_name($name);
354

355
  if ($value === FALSE) {
356
    $headers[$name_lower] = FALSE;
357
  }
358
  elseif (isset($headers[$name_lower]) && $append) {
359 360
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
361
    $headers[$name_lower] .= ',' . $value;
362 363
  }
  else {
364
    $headers[$name_lower] = $value;
365 366 367 368
  }
}

/**
369
 * Gets the HTTP response headers for the current page.
370 371 372 373
 *
 * @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.
374
 *
375 376 377
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
378
 *
379 380 381
 * @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.
382
 */
383
function drupal_get_http_header($name = NULL) {
384
  $headers = &drupal_static('drupal_http_headers', array());
385 386 387 388 389 390 391 392 393 394
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
395 396
 * Sets the preferred name for the HTTP header.
 *
397
 * Header names are case-insensitive, but for maximum compatibility they should
398 399
 * follow "common form" (see RFC 2616, section 4.2).
 *
400 401
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
402 403 404 405 406 407 408 409 410 411
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

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

412
/**
413
 * Sets HTTP headers in preparation for a cached page response.
414
 *
415 416
 * The headers allow as much as possible in proxies and browsers without any
 * particular knowledge about the pages. Modules can override these headers
417
 * using _drupal_add_http_header().
418
 *
419 420 421 422
 * If the request is conditional (using If-Modified-Since and If-None-Match),
 * and the conditions match those currently in the cache, a 304 Not Modified
 * response is sent.
 */
423 424 425 426 427 428 429 430 431 432 433
function drupal_serve_page_from_cache(Response $response, Request $request) {
  // Only allow caching in the browser and prevent that the response is stored
  // by an external proxy server when the following conditions apply:
  // 1. There is a session cookie on the request.
  // 2. The Vary: Cookie header is on the response.
  // 3. The Cache-Control header does not contain the no-cache directive.
  if ($request->cookies->has(session_name()) &&
    in_array('Cookie', $response->getVary()) &&
    !$response->headers->hasCacheControlDirective('no-cache')) {

    $response->setPrivate();
434 435
  }

436 437 438 439
  // Negotiate whether to use compression.
  if ($response->headers->get('Content-Encoding') == 'gzip' && extension_loaded('zlib')) {
    if (strpos($request->headers->get('Accept-Encoding'), 'gzip') !== FALSE) {
      // The response content is already gzip'ed, so make sure
440
      // zlib.output_compression does not compress it once more.
441
      ini_set('zlib.output_compression', '0');
442 443
    }
    else {
444 445 446 447 448 449
      // The client does not support compression. Decompress the content and
      // remove the Content-Encoding header.
      $content = $response->getContent();
      $content = gzinflate(substr(substr($content, 10), 0, -8));
      $response->setContent($content);
      $response->headers->remove('Content-Encoding');
450
    }
451 452
  }

453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
  // Perform HTTP revalidation.
  // @todo Use Response::isNotModified() as per https://drupal.org/node/2259489
  $last_modified = $response->getLastModified();
  if ($last_modified) {
    // See if the client has provided the required HTTP headers.
    $if_modified_since = $request->server->has('HTTP_IF_MODIFIED_SINCE') ? strtotime($request->server->get('HTTP_IF_MODIFIED_SINCE')) : FALSE;
    $if_none_match = $request->server->has('HTTP_IF_NONE_MATCH') ? stripslashes($request->server->get('HTTP_IF_NONE_MATCH')) : FALSE;

    if ($if_modified_since && $if_none_match
      && $if_none_match == $response->getEtag() // etag must match
      && $if_modified_since == $last_modified->getTimestamp()) {  // if-modified-since must match
      $response->setStatusCode(304);
      $response->setContent(NULL);

      // In the case of a 304 response, certain headers must be sent, and the
      // remaining may not (see RFC 2616, section 10.3.5).
      foreach (array_keys($response->headers->all()) as $name) {
        if (!in_array($name, array('content-location', 'expires', 'cache-control', 'vary'))) {
          $response->headers->remove($name);
        }
      }
    }
  }
Dries's avatar
 
Dries committed
476 477
}

478
/**
479
 * Translates a string to the current language or to a given language.
480
 *
481 482 483
 * 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
484 485 486 487 488
 * 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
489 490 491 492
 * @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.
 *
493
 * @section sec_translating_vars Translating Variables
494 495 496 497 498 499 500 501 502
 * 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:
503
 * @code
504
 * $text = t("@name's blog", array('@name' => user_format_name($account)));
505
 * @endcode
506
 * Basically, you can put variables like @name into your string, and t() will
507 508
 * substitute their sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
509 510 511
 * 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").
512 513 514 515
 *
 * @param $string
 *   A string containing the English string to translate.
 * @param $args
516 517 518
 *   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.
519
 * @param $options
520 521 522 523 524
 *   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.
525
 *
526 527
 * @return
 *   The translated string.
528
 *
529
 * @see format_string()
530
 * @ingroup sanitization
531 532
 */
function t($string, array $args = array(), array $options = array()) {
533
  return \Drupal::translation()->translate($string, $args, $options);
534 535 536
}

/**
537 538
 * Formats a string for HTML display by replacing variable placeholders.
 *
539
 * @see \Drupal\Component\Utility\String::format()
540 541 542 543
 * @see t()
 * @ingroup sanitization
 */
function format_string($string, array $args = array()) {
544
  return String::format($string, $args);
545 546
}

Gábor Hojtsy's avatar
Gábor Hojtsy committed
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
/**
 * 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.
 *
562 563
 * 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
564 565 566
 *
 * @param $text
 *   The text to check.
567
 *
Gábor Hojtsy's avatar
Gábor Hojtsy committed
568 569
 * @return
 *   TRUE if the text is valid UTF-8, FALSE if not.
570 571
 *
 * @see \Drupal\Component\Utility\Unicode::validateUtf8()
Gábor Hojtsy's avatar
Gábor Hojtsy committed
572 573
 */
function drupal_validate_utf8($text) {
574
  return Unicode::validateUtf8($text);
Dries's avatar
Dries committed
575 576
}

Dries's avatar
 
Dries committed
577
/**
578 579 580 581
 * 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.
582 583
 *
 * @todo The above comment is incorrect: http://drupal.org/node/1547294.
Dries's avatar
 
Dries committed
584
 */
585
function request_uri($omit_query_string = FALSE) {
586 587 588 589
  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
590
    if (isset($_SERVER['argv'][0])) {
591
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
592
    }
593
    elseif (isset($_SERVER['QUERY_STRING'])) {
594
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
595
    }
596 597 598
    else {
      $uri = $_SERVER['SCRIPT_NAME'];
    }
Dries's avatar
 
Dries committed
599
  }
600 601
  // Prevent multiple slashes to avoid cross site requests via the Form API.
  $uri = '/' . ltrim($uri, '/');
602

603
  return $omit_query_string ? strtok($uri, '?') : $uri;
Dries's avatar
 
Dries committed
604
}
Dries's avatar
Dries committed
605

606
/**
607
 * Logs an exception.
608
 *
609
 * This is a wrapper logging function which automatically decodes an exception.
610 611 612 613 614 615 616
 *
 * @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
617
 *   information about the passed-in exception is used.
618
 * @param $variables
619 620 621
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
622 623 624 625 626
 * @param $severity
 *   The severity of the message, as per RFC 3164.
 * @param $link
 *   A link to associate with the message.
 *
627
 * @see \Drupal\Core\Utility\Error::decodeException()
628
 */
629
function watchdog_exception($type, Exception $exception, $message = NULL, $variables = array(), $severity = RfcLogLevel::ERROR, $link = NULL) {
630

631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
  // 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);
646 647
}

Dries's avatar
 
Dries committed
648
/**
649
 * Sets a message to display to the user.
Dries's avatar
 
Dries committed
650
 *
651 652
 * Messages are stored in a session variable and displayed in the page template
 * via the $messages theme variable.
Dries's avatar
 
Dries committed
653
 *
654 655 656 657 658 659 660 661 662 663 664 665
 * 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:
666
 *   - 'status'
667
 *   - 'warning'
668
 *   - 'error'
669 670
 * @param bool $repeat
 *   (optional) If this is FALSE and the message is already set, then the
671
 *   message won't be repeated. Defaults to FALSE.
672 673 674
 *
 * @return array|null
 *   A multidimensional array with keys corresponding to the set message types.
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
 *   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.
696 697 698
 *
 * @see drupal_get_messages()
 * @see theme_status_messages()
Dries's avatar
 
Dries committed
699
 */
700
function drupal_set_message($message = NULL, $type = 'status', $repeat = FALSE) {
701
  if (isset($message)) {
Dries's avatar
 
Dries committed
702 703 704 705
    if (!isset($_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type] = array();
    }

706 707 708 709 710 711
    $new = array(
      'safe' => SafeMarkup::isSafe($message),
      'message' => $message,
    );
    if ($repeat || !in_array($new, $_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type][] = $new;
712
    }
713

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

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

Dries's avatar
 
Dries committed
722
/**
723
 * Returns all messages that have been set with drupal_set_message().
Dries's avatar
 
Dries committed
724
 *
725 726 727 728 729 730 731 732 733 734 735
 * @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.
736
 *
737
 * @return array
738 739 740 741
 *   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
742
 *   drupal_set_message() for the array structure of individual messages.
743 744 745
 *
 * @see drupal_set_message()
 * @see theme_status_messages()
Dries's avatar
 
Dries committed
746
 */
747
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
748
  if ($messages = drupal_set_message()) {
749 750 751 752 753 754 755 756
    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'];
      }
    }
757
    if ($type) {
758
      if ($clear_queue) {
759
        unset($_SESSION['messages'][$type]);
760
      }
761 762 763
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
764 765
    }
    else {
766
      if ($clear_queue) {
767
        unset($_SESSION['messages']);
768
      }
769 770
      return $messages;
    }
771
  }
772
  return array();
773 774
}

775
/**
776 777 778 779 780 781 782 783
 * 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
784 785
 *
 * @param $phase
786
 *   A constant telling which phase to bootstrap to. Possible values:
787
 *   - DRUPAL_BOOTSTRAP_CONFIGURATION: Initializes configuration.
788
 *   - DRUPAL_BOOTSTRAP_KERNEL: Initializes a kernel.
789
 *
790
 * @return int
791
 *   The most recently completed phase.
792 793 794
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Interact directly with the kernel.
795
 */
796
function drupal_bootstrap($phase = NULL) {
797 798 799 800 801
  // Temporary variables used for booting later legacy phases.
  /** @var \Drupal\Core\DrupalKernel $kernel */
  static $kernel;
  static $boot_level = 0;

802
  if (isset($phase)) {
803 804
    $request = Request::createFromGlobals();
    for ($current_phase = $boot_level; $current_phase <= $phase; $current_phase++) {
805

806 807
      switch ($current_phase) {
        case DRUPAL_BOOTSTRAP_CONFIGURATION:
808 809
          $classloader = require __DIR__ . '/../vendor/autoload.php';
          $kernel = DrupalKernel::createFromRequest($request, $classloader, 'prod');
810 811
          break;

812
        case DRUPAL_BOOTSTRAP_KERNEL:
813
          $kernel->boot();
814 815
          break;

816
        case DRUPAL_BOOTSTRAP_PAGE_CACHE:
817
          $kernel->handlePageCache($request);
818 819
          break;

820
        case DRUPAL_BOOTSTRAP_CODE:
821
        case DRUPAL_BOOTSTRAP_FULL:
822
          $kernel->prepareLegacyRequest($request);
823 824
          break;
      }
825
    }
826
    $boot_level = $phase;
827 828
  }

829
  return \Drupal::getContainer() ? DRUPAL_BOOTSTRAP_CODE : DRUPAL_BOOTSTRAP_CONFIGURATION;
830 831
}

832
/**
833
 * Returns the time zone of the current user.
834 835 836
 */
function drupal_get_user_timezone() {
  global $user;
837
  $config = \Drupal::config('system.date');
838

839
  if ($user && $config->get('timezone.user.configurable') && $user->isAuthenticated() && $user->getTimezone()) {
840
    return $user->getTimezone();
841 842
  }
  else {
843 844
    // Ignore PHP strict notice if time zone has not yet been set in the php.ini
    // configuration.
845
    $config_data_default_timezone = $config->get('timezone.default');
846
    return !empty($config_data_default_timezone) ? $config_data_default_timezone : @date_default_timezone_get();
847 848 849
  }
}

850
/**
851
 * Provides custom PHP error handling.
852 853 854 855 856 857 858 859 860 861
 *
 * @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
862 863
 *   An array that points to the active symbol table at the point the error
 *   occurred.
864 865
 */
function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
866
  require_once __DIR__ . '/errors.inc';
867 868 869 870
  _drupal_error_handler_real($error_level, $message, $filename, $line, $context);
}

/**
871
 * Provides custom PHP exception handling.
872 873