bootstrap.inc 53.8 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\Site\Settings;
16
use Drupal\Core\Utility\Error;
17
use Symfony\Component\ClassLoader\ApcClassLoader;
18
use Symfony\Component\HttpFoundation\Request;
19
use Symfony\Component\HttpFoundation\Response;
20
use Drupal\Core\Language\LanguageInterface;
21

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

/**
 * Minimum supported version of PHP on Debian.
 *
 * @see https://www.drupal.org/node/2267551.
 */
const DRUPAL_MINIMUM_PHP_DEBIAN = '5.4.4-14+deb7u14';
33
34
35

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

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

62
63
64
65
66
67
/**
 * @defgroup logging_severity_levels Logging severity levels
 * @{
 * Logging severity levels as defined in RFC 3164.
 *
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
68
 * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
69
 * for use in the syslog() function, but their values on Windows builds do not
70
 * correspond to RFC 3164. The associated PHP bug report was closed with the
71
72
73
74
75
76
77
78
79
80
81
82
83
 * comment, "And it's also not a bug, as Windows just have less log levels,"
 * and "So the behavior you're seeing is perfectly normal."
 *
 * @see http://www.faqs.org/rfcs/rfc3164.html
 * @see http://bugs.php.net/bug.php?id=18090
 * @see http://php.net/manual/function.syslog.php
 * @see http://php.net/manual/network.constants.php
 * @see watchdog_severity_levels()
 */

/**
 * Log message severity -- Emergency: system is unusable.
 */
84
const WATCHDOG_EMERGENCY = 0;
85
86
87
88

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
89
const WATCHDOG_ALERT = 1;
90
91

/**
92
 * Log message severity -- Critical conditions.
93
 */
94
const WATCHDOG_CRITICAL = 2;
95
96

/**
97
 * Log message severity -- Error conditions.
98
 */
99
const WATCHDOG_ERROR = 3;
100
101

/**
102
 * Log message severity -- Warning conditions.
103
 */
104
const WATCHDOG_WARNING = 4;
105
106

/**
107
 * Log message severity -- Normal but significant conditions.
108
 */
109
const WATCHDOG_NOTICE = 5;
110
111

/**
112
 * Log message severity -- Informational messages.
113
 */
114
const WATCHDOG_INFO = 6;
115
116

/**
117
 * Log message severity -- Debug-level messages.
118
 */
119
const WATCHDOG_DEBUG = 7;
120
121
122
123
124

/**
 * @} End of "defgroup logging_severity_levels".
 */

125
126
/**
 * First bootstrap phase: initialize configuration.
127
128
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
129
 */
130
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
131
132

/**
133
134
135
 * Second bootstrap phase, initialize a kernel.
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
136
 */
137
const DRUPAL_BOOTSTRAP_KERNEL = 1;
138
139

/**
140
 * Third bootstrap phase: try to serve a cached page.
141
142
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
143
 */
144
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
145
146

/**
147
 * Fourth bootstrap phase: load code for subsystems and modules.
148
149
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
150
 */
151
const DRUPAL_BOOTSTRAP_CODE = 3;
152
153

/**
154
 * Final bootstrap phase: initialize language, path, theme, and modules.
155
156
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
157
 */
158
const DRUPAL_BOOTSTRAP_FULL = 4;
159

160
161
162
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
163
const DRUPAL_ANONYMOUS_RID = 'anonymous';
164
165
166
167

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

170
171
172
173
174
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

175
/**
176
 * Time of the current request in seconds elapsed since the Unix Epoch.
177
 *
178
179
180
181
182
183
 * 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
184
 */
185
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
186

187
188
189
/**
 * Regular expression to match PHP function names.
 *
190
 * @see http://php.net/manual/language.functions.php
191
 */
192
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
193

194
195
196
/**
 * $config_directories key for active directory.
 *
197
 * @see config_get_config_directory()
198
199
200
201
202
203
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
204
 * @see config_get_config_directory()
205
206
207
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

208
209
210
211
212
213
214
/**
 * 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
215
/**
216
 * Returns the appropriate configuration directory.
Dries's avatar
   
Dries committed
217
 *
218
 * @param bool $require_settings
219
220
221
222
 *   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.
223
 * @param bool $reset
224
 *   Force a full search for matching directories even if one had been
225
 *   found previously. Defaults to FALSE.
226
227
228
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   (optional) The current request. Defaults to \Drupal::request() or a new
 *   request created from globals.
229
 *
230
231
 * @return string
 *   The path of the matching directory.@see default.settings.php
232
 *
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 * @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();
    }
247
  }
248
249
  if (\Drupal::hasService('kernel')) {
    $site_path = \Drupal::service('kernel')->getSitePath();
250
  }
251
252
  if (!isset($site_path) || empty($site_path)) {
    $site_path = DrupalKernel::findSitePath($request, $require_settings);
Dries's avatar
 
Dries committed
253
  }
254
  return $site_path;
Dries's avatar
 
Dries committed
255
}
256
/**
257
258
259
260
261
 * 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.
262
263
264
265
 *
 * @return string
 *   The configuration directory path.
 */
266
267
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
268

269
  if (!empty($config_directories[$type])) {
270
    return $config_directories[$type];
271
  }
272
  throw new \Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
273
274
}

Dries's avatar
Dries committed
275
/**
276
277
278
279
 * 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
280
 *
Dries's avatar
Dries committed
281
282
 * 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
283
 * configuration. For example, a module 'foo' may legally be located
Dries's avatar
Dries committed
284
285
 * in any of these three places:
 *
286
287
288
 * core/modules/foo/foo.info.yml
 * modules/foo/foo.info.yml
 * sites/example.com/modules/foo/foo.info.yml
Dries's avatar
Dries committed
289
290
291
292
 *
 * 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
293
 * @param $type
294
295
 *   The type of the item; one of 'core', 'profile', 'module', 'theme', or
 *   'theme_engine'.
Dries's avatar
Dries committed
296
 * @param $name
297
298
 *   The name of the item for which the filename is requested. Ignored for
 *   $type 'core'.
Dries's avatar
Dries committed
299
300
301
302
303
 * @param $filename
 *   The filename of the item if it is to be set explicitly rather
 *   than by consulting the database.
 *
 * @return
304
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
305
 */
Dries's avatar
Dries committed
306
function drupal_get_filename($type, $name, $filename = NULL) {
307
308
  // The location of files will not change during the request, so do not use
  // drupal_static().
309
  static $files = array();
Dries's avatar
Dries committed
310

311
312
313
314
315
316
317
318
  // 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';
  }

319
320
321
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
322
  if ($type == 'profile') {
323
    $type = 'module';
324
  }
325
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
326
327
328
    $files[$type] = array();
  }

329
  if (isset($filename)) {
Dries's avatar
Dries committed
330
331
    $files[$type][$name] = $filename;
  }
332
333
334
335
336
337
  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')) {
338
339
340
      foreach (\Drupal::moduleHandler()->getModuleList() as $module_name => $module) {
        $files[$type][$module_name] = $module->getPathname();
      }
341
342
343
344
345
    }
    // 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());
346
    }
347
    // If still unknown, perform a filesystem scan.
348
    if (!isset($files[$type][$name])) {
349
350
351
352
      $listing = new ExtensionDiscovery();
      // Prevent an infinite recursion by this legacy function.
      if ($original_type == 'profile') {
        $listing->setProfileDirectories(array());
353
      }
354
      foreach ($listing->scan($original_type) as $extension_name => $file) {
355
        $files[$type][$extension_name] = $file->getPathname();
Dries's avatar
Dries committed
356
357
358
359
      }
    }
  }

360
361
362
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
363
364
}

365
366
367
368
369
370
371
372
373
374
375
376
/**
 * 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(),
377
    \Drupal::service('content_negotiation')->getContentType($request),
378
379
380
381
  );
  return sha1(implode(':', $cid_parts));
}

Dries's avatar
   
Dries committed
382
/**
383
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
384
 *
385
386
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request for this page.
387
 *
388
389
 * @return \Symfony\Component\HttpFoundation\Response
 *   The response, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
390
 */
391
function drupal_page_get_cache(Request $request) {
392
393
394
  $cache = \Drupal::cache('render')->get(drupal_page_cache_get_cid($request));
  if ($cache) {
    return $cache->data;
395
  }
396
397
}

398
/**
399
 * Sets an HTTP response header for the current page.
400
401
402
403
404
 *
 * 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
405
 *   The HTTP header name, or the special 'Status' header name.
406
 * @param $value
407
408
409
 *   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".
410
411
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
412
 *
413
414
415
 * @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.
416
 */
417
function drupal_add_http_header($name, $value, $append = FALSE) {
418
  // The headers as name/value pairs.
419
  $headers = &drupal_static('drupal_http_headers', array());
420

421
  $name_lower = strtolower($name);
422
  _drupal_set_preferred_header_name($name);
423

424
  if ($value === FALSE) {
425
    $headers[$name_lower] = FALSE;
426
  }
427
  elseif (isset($headers[$name_lower]) && $append) {
428
429
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
430
    $headers[$name_lower] .= ',' . $value;
431
432
  }
  else {
433
    $headers[$name_lower] = $value;
434
435
436
437
  }
}

/**
438
 * Gets the HTTP response headers for the current page.
439
440
441
442
 *
 * @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.
443
 *
444
445
446
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
447
 *
448
449
450
 * @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.
451
 */
452
function drupal_get_http_header($name = NULL) {
453
  $headers = &drupal_static('drupal_http_headers', array());
454
455
456
457
458
459
460
461
462
463
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
464
465
 * Sets the preferred name for the HTTP header.
 *
466
 * Header names are case-insensitive, but for maximum compatibility they should
467
468
 * follow "common form" (see RFC 2616, section 4.2).
 *
469
470
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
471
472
473
474
475
476
477
478
479
480
481
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

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

/**
482
483
484
485
 * Sends the HTTP response headers that were previously set, adding defaults.
 *
 * Headers are set in drupal_add_http_header(). Default headers are not set
 * if they have been replaced or unset using drupal_add_http_header().
486
 *
487
488
489
490
491
 * @param array $default_headers
 *   (optional) An array of headers as name/value pairs.
 * @param bool $only_default
 *   (optional) If TRUE and headers have already been sent, send only the
 *   specified headers.
492
 *
493
494
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
495
496
497
 */
function drupal_send_headers($default_headers = array(), $only_default = FALSE) {
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
498
  $headers = drupal_get_http_header();
499
500
501
502
503
504
505
506
507
508
509
510
511
512
  if ($only_default && $headers_sent) {
    $headers = array();
  }
  $headers_sent = TRUE;

  $header_names = _drupal_set_preferred_header_name();
  foreach ($default_headers as $name => $value) {
    $name_lower = strtolower($name);
    if (!isset($headers[$name_lower])) {
      $headers[$name_lower] = $value;
      $header_names[$name_lower] = $name;
    }
  }
  foreach ($headers as $name_lower => $value) {
513
    if ($name_lower == 'status') {
514
515
516
      header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
    }
    // Skip headers that have been unset.
517
    elseif ($value !== FALSE) {
518
519
520
521
522
      header($header_names[$name_lower] . ': ' . $value);
    }
  }
}

Dries's avatar
   
Dries committed
523
/**
524
 * Sets HTTP headers in preparation for a page response.
525
 *
526
527
528
529
 * Authenticated users are always given a 'no-cache' header, and will fetch a
 * fresh page on every request. This prevents authenticated users from seeing
 * locally cached pages.
 *
530
 * Also give each page a unique ETag. This should force clients to include both
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 * an If-Modified-Since header and an If-None-Match header when doing
 * conditional requests for the page (required by RFC 2616, section 13.3.4),
 * making the validation more robust. This is a workaround for a bug in Mozilla
 * Firefox that is triggered when Drupal's caching is enabled and the user
 * accesses Drupal via an HTTP proxy (see
 * https://bugzilla.mozilla.org/show_bug.cgi?id=269303): When an authenticated
 * user requests a page, and then logs out and requests the same page again,
 * Firefox may send a conditional request based on the page that was cached
 * locally when the user was logged in. If this page did not have an ETag
 * header, the request only contains an If-Modified-Since header. The date will
 * be recent, because with authenticated users the Last-Modified header always
 * refers to the time of the request. If the user accesses Drupal via a proxy
 * server, and the proxy already has a cached copy of the anonymous page with an
 * older Last-Modified date, the proxy may respond with 304 Not Modified, making
 * the client think that the anonymous and authenticated pageviews are
 * identical.
547
 *
548
 * @see drupal_page_set_cache()
549
 *
550
551
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
Dries's avatar
   
Dries committed
552
 */
Dries's avatar
 
Dries committed
553
function drupal_page_header() {
554
555
556
557
558
559
560
561
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
  if ($headers_sent) {
    return TRUE;
  }
  $headers_sent = TRUE;

  $default_headers = array(
    'Expires' => 'Sun, 19 Nov 1978 05:00:00 GMT',
562
    'Last-Modified' => gmdate(DateTimePlus::RFC7231, REQUEST_TIME),
563
564
565
566
    'Cache-Control' => 'no-cache, must-revalidate, post-check=0, pre-check=0',
    'ETag' => '"' . REQUEST_TIME . '"',
  );
  drupal_send_headers($default_headers);
567
}
Dries's avatar
   
Dries committed
568

569
/**
570
 * Sets HTTP headers in preparation for a cached page response.
571
 *
572
573
 * The headers allow as much as possible in proxies and browsers without any
 * particular knowledge about the pages. Modules can override these headers
574
 * using drupal_add_http_header().
575
 *
576
577
578
579
 * 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.
 */
580
581
582
583
584
585
586
587
588
589
590
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();
591
592
  }

593
594
595
596
  // 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
597
      // zlib.output_compression does not compress it once more.
598
      ini_set('zlib.output_compression', '0');
599
600
    }
    else {
601
602
603
604
605
606
      // 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');
607
    }
608
609
  }

610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
  // 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
633
634
}

635
/**
636
 * Translates a string to the current language or to a given language.
637
 *
638
639
640
 * 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
641
642
643
644
645
 * 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
646
647
648
649
 * @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.
 *
650
 * @section sec_translating_vars Translating Variables
651
652
653
654
655
656
657
658
659
 * 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:
660
 * @code
661
 * $text = t("@name's blog", array('@name' => user_format_name($account)));
662
 * @endcode
663
 * Basically, you can put variables like @name into your string, and t() will
664
665
 * substitute their sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
666
667
668
 * 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").
669
670
671
672
 *
 * @param $string
 *   A string containing the English string to translate.
 * @param $args
673
674
675
 *   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.
676
 * @param $options
677
678
679
680
681
 *   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.
682
 *
683
684
 * @return
 *   The translated string.
685
 *
686
 * @see format_string()
687
 * @ingroup sanitization
688
689
 */
function t($string, array $args = array(), array $options = array()) {
690
  return \Drupal::translation()->translate($string, $args, $options);
691
692
693
}

/**
694
695
 * Formats a string for HTML display by replacing variable placeholders.
 *
696
 * @see \Drupal\Component\Utility\String::format()
697
698
699
700
 * @see t()
 * @ingroup sanitization
 */
function format_string($string, array $args = array()) {
701
  return String::format($string, $args);
702
703
}

Gábor Hojtsy's avatar
Gábor Hojtsy committed
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
/**
 * 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.
 *
719
720
 * 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
721
722
723
 *
 * @param $text
 *   The text to check.
724
 *
Gábor Hojtsy's avatar
Gábor Hojtsy committed
725
726
 * @return
 *   TRUE if the text is valid UTF-8, FALSE if not.
727
728
 *
 * @see \Drupal\Component\Utility\Unicode::validateUtf8()
Gábor Hojtsy's avatar
Gábor Hojtsy committed
729
730
 */
function drupal_validate_utf8($text) {
731
  return Unicode::validateUtf8($text);
Dries's avatar
Dries committed
732
733
}

Dries's avatar
   
Dries committed
734
/**
735
736
737
738
 * 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.
739
740
 *
 * @todo The above comment is incorrect: http://drupal.org/node/1547294.
Dries's avatar
   
Dries committed
741
 */
742
function request_uri($omit_query_string = FALSE) {
743
744
745
746
  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
747
    if (isset($_SERVER['argv'][0])) {
748
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
749
    }
750
    elseif (isset($_SERVER['QUERY_STRING'])) {
751
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
752
    }
753
754
755
    else {
      $uri = $_SERVER['SCRIPT_NAME'];
    }
Dries's avatar
 
Dries committed
756
  }
757
758
  // Prevent multiple slashes to avoid cross site requests via the Form API.
  $uri = '/' . ltrim($uri, '/');
759

760
  return $omit_query_string ? strtok($uri, '?') : $uri;
Dries's avatar
 
Dries committed
761
}
Dries's avatar
Dries committed
762

763
/**
764
 * Logs an exception.
765
 *
766
 * This is a wrapper logging function which automatically decodes an exception.
767
768
769
770
771
772
773
 *
 * @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
774
 *   information about the passed-in exception is used.
775
 * @param $variables
776
777
778
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
779
780
781
782
783
 * @param $severity
 *   The severity of the message, as per RFC 3164.
 * @param $link
 *   A link to associate with the message.
 *
784
 * @see \Drupal\Core\Utility\Error::decodeException()
785
 */
786
function watchdog_exception($type, Exception $exception, $message = NULL, $variables = array(), $severity = WATCHDOG_ERROR, $link = NULL) {
787

788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
  // 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);
803
804
}

Dries's avatar
   
Dries committed
805
/**
806
 * Sets a message to display to the user.
Dries's avatar
   
Dries committed
807
 *
808
809
 * Messages are stored in a session variable and displayed in the page template
 * via the $messages theme variable.
Dries's avatar
   
Dries committed
810
 *
811
812
813
814
815
816
817
818
819
820
821
822
 * 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:
823
 *   - 'status'
824
 *   - 'warning'
825
 *   - 'error'
826
827
 * @param bool $repeat
 *   (optional) If this is FALSE and the message is already set, then the
828
 *   message won't be repeated. Defaults to FALSE.
829
830
831
 *
 * @return array|null
 *   A multidimensional array with keys corresponding to the set message types.
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
 *   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.
853
854
855
 *
 * @see drupal_get_messages()
 * @see theme_status_messages()
Dries's avatar
   
Dries committed
856
 */
857
function drupal_set_message($message = NULL, $type = 'status', $repeat = FALSE) {
858
  if (isset($message)) {
Dries's avatar
   
Dries committed
859
860
861
862
    if (!isset($_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type] = array();
    }

863
    if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
864
865
866
867
      $_SESSION['messages'][$type][] = array(
        'safe' => SafeMarkup::isSafe($message),
        'message' => $message,
      );
868
    }
869

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

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

Dries's avatar
   
Dries committed
878
/**
879
 * Returns all messages that have been set with drupal_set_message().
Dries's avatar
   
Dries committed
880
 *
881
882
883
884
885
886
887
888
889
890
891
 * @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.
892
 *
893
 * @return array
894
895
896
897
 *   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
898
 *   drupal_set_message() for the array structure of individual messages.
899
900
901
 *
 * @see drupal_set_message()
 * @see theme_status_messages()
Dries's avatar
   
Dries committed
902
 */
903
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
904
  if ($messages = drupal_set_message()) {
905
906
907
908
909
910
911
912
    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'];
      }
    }
913
    if ($type) {
914
      if ($clear_queue) {
915
        unset($_SESSION['messages'][$type]);
916
      }
917
918
919
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
920
921
    }
    else {
922
      if ($clear_queue) {
923
        unset($_SESSION['messages']);
924
      }
925
926
      return $messages;
    }
927
  }
928
  return array();
929
930
}

931
/**
932
933
934
935
936
937
938
939
 * 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
940
941
 *
 * @param $phase
942
 *   A constant telling which phase to bootstrap to. Possible values:
943
 *   - DRUPAL_BOOTSTRAP_CONFIGURATION: Initializes configuration.
944
 *   - DRUPAL_BOOTSTRAP_KERNEL: Initializes a kernel.
945
 *
946
 * @return int
947
 *   The most recently completed phase.
948
949
950
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Interact directly with the kernel.
951
 */
952
function drupal_bootstrap($phase = NULL) {
953
954
955
956
957
  // Temporary variables used for booting later legacy phases.
  /** @var \Drupal\Core\DrupalKernel $kernel */
  static $kernel;
  static $boot_level = 0;

958
  if (isset($phase)) {
959
960
    $request = Request::createFromGlobals();
    for ($current_phase = $boot_level; $current_phase <= $phase; $current_phase++) {
961

962
963
      switch ($current_phase) {
        case DRUPAL_BOOTSTRAP_CONFIGURATION:
964
965
          $classloader = require __DIR__ . '/../vendor/autoload.php';
          $kernel = DrupalKernel::createFromRequest($request, $classloader, 'prod');
966
967
          break;

968
        case DRUPAL_BOOTSTRAP_KERNEL:
969
          $kernel->boot();
970
971
          break;

972
        case DRUPAL_BOOTSTRAP_PAGE_CACHE:
973
          $kernel->handlePageCache($request);
974
975
          break;

976
        case DRUPAL_BOOTSTRAP_CODE:
977
        case DRUPAL_BOOTSTRAP_FULL:
978
          $kernel->prepareLegacyRequest($request);
979
980
          break;
      }
981
    }
982
    $boot_level = $phase;
983
984
  }

985
  return \Drupal::getContainer() ? DRUPAL_BOOTSTRAP_CODE : DRUPAL_BOOTSTRAP_CONFIGURATION;
986
987
}

988
/**
989
 * Returns the time zone of the current user.
990
991
992
 */
function drupal_get_user_timezone() {
  global $user;
993
  $config = \Drupal::config('system.date');
994

995
  if ($user && $config->get('timezone.user.configurable') && $user->isAuthenticated() && $user->getTimezone()) {
996
    return $user->getTimezone();
997
998
  }
  else {