bootstrap.inc 48.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
 *
 * Minimum version is 5.4.5, or 5.4.4-14+deb7u14 on Debian Wheezy.
27
28
29
 *
 * @see https://www.drupal.org/node/2267551.
 */
30
define('DRUPAL_MINIMUM_PHP', PHP_VERSION == '5.4.4-14+deb7u14' ? '5.4.4' : '5.4.5');
31
32
33

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

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/**
 * 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';

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

/**
68
69
70
 * Second bootstrap phase, initialize a kernel.
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
71
 */
72
const DRUPAL_BOOTSTRAP_KERNEL = 1;
73
74

/**
75
 * Third bootstrap phase: try to serve a cached page.
76
77
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
78
 */
79
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
80
81

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

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

95
96
97
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
98
const DRUPAL_ANONYMOUS_RID = 'anonymous';
99
100
101
102

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

105
106
107
108
109
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

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

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

129
130
131
/**
 * $config_directories key for active directory.
 *
132
 * @see config_get_config_directory()
133
134
135
136
137
138
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
139
 * @see config_get_config_directory()
140
141
142
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

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

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

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

246
247
248
249
250
251
252
253
  // 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';
  }

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

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

295
296
297
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
298
299
}

300
301
302
303
304
305
306
307
308
309
310
311
/**
 * 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(),
312
    \Drupal::service('content_negotiation')->getContentType($request),
313
314
315
316
  );
  return sha1(implode(':', $cid_parts));
}

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

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

356
  $name_lower = strtolower($name);
357
  _drupal_set_preferred_header_name($name);
358

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

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

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

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

416
/**
417
 * Sets HTTP headers in preparation for a cached page response.
418
 *
419
420
 * The headers allow as much as possible in proxies and browsers without any
 * particular knowledge about the pages. Modules can override these headers
421
 * using _drupal_add_http_header().
422
 *
423
424
425
426
 * 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.
 */
427
428
429
430
431
432
433
434
435
436
437
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();
438
439
  }

440
441
442
443
  // 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
444
      // zlib.output_compression does not compress it once more.
445
      ini_set('zlib.output_compression', '0');
446
447
    }
    else {
448
449
450
451
452
453
      // 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');
454
    }
455
456
  }

457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
  // 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
480
481
}

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

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

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

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

607
  return $omit_query_string ? strtok($uri, '?') : $uri;
Dries's avatar
 
Dries committed
608
}
Dries's avatar
Dries committed
609

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

635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
  // 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);
650
651
}

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

710
    if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
711
712
713
714
      $_SESSION['messages'][$type][] = array(
        'safe' => SafeMarkup::isSafe($message),
        'message' => $message,
      );
715
    }
716

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

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

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

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

805
  if (isset($phase)) {
806
807
    $request = Request::createFromGlobals();
    for ($current_phase = $boot_level; $current_phase <= $phase; $current_phase++) {
808

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

815
        case DRUPAL_BOOTSTRAP_KERNEL:
816
          $kernel->boot();
817
818
          break;

819
        case DRUPAL_BOOTSTRAP_PAGE_CACHE:
820
          $kernel->handlePageCache($request);
821
822
          break;

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

832
  return \Drupal::getContainer() ? DRUPAL_BOOTSTRAP_CODE : DRUPAL_BOOTSTRAP_CONFIGURATION;
833
834
}

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

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

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

/**
874
 * Provides custom PHP exception handling.
875
876
877
878
879
880
881
882
883
 *
 * 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) {
884
  require_once __DIR__ . '/errors.inc';
885
886
887

  try {
    // Log the message to the watchdog and return an error page to the user.
888
    _drupal_log_error(Error::decodeException($exception), TRUE);
889
890
891
892
  }
  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.
893
894
    if (error_displayable()) {
      print '<h1>Additional uncaught exception thrown while handling exception.</h1>';
895
896
      print '<h2>Original</h2><p>' . Error::renderExceptionSafe($exception) . '</p>';
      print '<h2>Additional</h2><p>' . Error::renderExceptionSafe($exception2) . '</p><hr />';
897
898
    }
  }
899
900
}

901
902
903
904
905
906
/**
 * Returns the current bootstrap phase for this Drupal process.
 *
 * The current phase is the one most recently completed by drupal_bootstrap().
 *
 * @see drupal_bootstrap()
907
908
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
909
910
911
912
913
 */
function drupal_get_bootstrap_phase() {
  return drupal_bootstrap();
}

914
915
916
/**
 * Returns the list of enabled modules.
 *
917
918
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::moduleHandler()->getModuleList().
919
920
921
922
 *
 * @see \Drupal\Core\Extension\ModuleHandler::getModuleList()
 */
function module_list() {
923
  $modules = array_keys(\Drupal::moduleHandler()->getModuleList());
924
925
926
927
928
929
  return array_combine($modules, $modules);
}

/**
 * Determines which modules are implementing a hook.
 *
930
931
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::moduleHandler()->getImplementations($hook).
932
933
934
935
 *
 * @see \Drupal\Core\Extension\ModuleHandler::getImplementations()
 */
function module_implements($hook) {
936
  return \Drupal::moduleHandler()->getImplementations($hook);
937
938
}

939
940
941
/**
 * Invokes a hook in a particular module.
 *
942
943
 * All arguments are passed by value. Use \Drupal::moduleHandler()->alter() if
 * you need to pass arguments by reference.
944
 *
945
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0. Use
946
947
 *   \Drupal::moduleHandler()->invoke($module, $hook, $args = array()).
 *
948
 * @see \Drupal\Core\Extension\ModuleHandler::alter()
949
950
951
952
953
954
955
956
 * @see \Drupal\Core\Extension\ModuleHandler::invoke()
 */
function module_invoke($module, $hook) {
  $args = func_get_args();
  // Remove $module and $hook from the arguments.
  unset($args[0], $args[1]);
  return \Drupal::moduleHandler()->invoke($module, $hook, $args);
}
957

958
/**
959
 * Returns the test prefix if this is an internal request from SimpleTest.
960
 *
961
 * @param string $new_prefix
962
 *   Internal use only. A new prefix to be stored.
963
 *
964
 * @return string|FALSE
965
966
967
 *   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.
968
 */
969
function drupal_valid_test_ua($new_prefix = NULL) {
970
971
  static $test_prefix;

972
973
974
  if (isset($new_prefix)) {
    $test_prefix = $new_prefix;
  }
975
976
977
  if (isset($test_prefix)) {
    return $test_prefix;
  }
978
979
980
  // Unless the below User-Agent and HMAC validation succeeds, we are not in
  // a test environment.
  $test_prefix = FALSE;
981

982
983
  // 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.
984
985
986
  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;
987
988
989
990
991
992
993
994
995
996
997