bootstrap.inc 57.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
const DRUPAL_MINIMUM_PHP = '5.4.2';
26
27
28
29

/**
 * Minimum recommended value of PHP memory_limit.
 */
30
const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '32M';
31

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

52
53
54
55
56
57
/**
 * @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
58
 * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
59
 * for use in the syslog() function, but their values on Windows builds do not
60
 * correspond to RFC 3164. The associated PHP bug report was closed with the
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 * 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()
 * @see watchdog_severity_levels()
 */

/**
 * Log message severity -- Emergency: system is unusable.
 */
75
const WATCHDOG_EMERGENCY = 0;
76
77
78
79

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
80
const WATCHDOG_ALERT = 1;
81
82

/**
83
 * Log message severity -- Critical conditions.
84
 */
85
const WATCHDOG_CRITICAL = 2;
86
87

/**
88
 * Log message severity -- Error conditions.
89
 */
90
const WATCHDOG_ERROR = 3;
91
92

/**
93
 * Log message severity -- Warning conditions.
94
 */
95
const WATCHDOG_WARNING = 4;
96
97

/**
98
 * Log message severity -- Normal but significant conditions.
99
 */
100
const WATCHDOG_NOTICE = 5;
101
102

/**
103
 * Log message severity -- Informational messages.
104
 */
105
const WATCHDOG_INFO = 6;
106
107

/**
108
 * Log message severity -- Debug-level messages.
109
 */
110
const WATCHDOG_DEBUG = 7;
111
112
113
114
115

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

116
117
/**
 * First bootstrap phase: initialize configuration.
118
119
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
120
 */
121
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
122
123

/**
124
125
126
 * Second bootstrap phase, initialize a kernel.
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
127
 */
128
const DRUPAL_BOOTSTRAP_KERNEL = 1;
129
130

/**
131
 * Third bootstrap phase: try to serve a cached page.
132
133
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
134
 */
135
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
136
137

/**
138
 * Fourth bootstrap phase: load code for subsystems and modules.
139
140
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
141
 */
142
const DRUPAL_BOOTSTRAP_CODE = 3;
143
144

/**
145
 * Final bootstrap phase: initialize language, path, theme, and modules.
146
147
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
148
 */
149
const DRUPAL_BOOTSTRAP_FULL = 4;
150

151
152
153
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
154
const DRUPAL_ANONYMOUS_RID = 'anonymous';
155
156
157
158

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

161
162
163
164
165
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

166
/**
167
 * Time of the current request in seconds elapsed since the Unix Epoch.
168
 *
169
170
171
172
173
174
 * 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
175
 */
176
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
177

178
179
180
/**
 * Regular expression to match PHP function names.
 *
181
 * @see http://php.net/manual/language.functions.php
182
 */
183
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
184

185
186
187
/**
 * $config_directories key for active directory.
 *
188
 * @see config_get_config_directory()
189
190
191
192
193
194
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
195
 * @see config_get_config_directory()
196
197
198
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

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

260
  if (!empty($config_directories[$type])) {
261
    return $config_directories[$type];
262
  }
263
  throw new \Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
264
265
}

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

302
303
304
305
306
307
308
309
  // 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';
  }

310
311
312
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
313
  if ($type == 'profile') {
314
    $type = 'module';
315
  }
316
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
317
318
319
    $files[$type] = array();
  }

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

351
352
353
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
354
355
}

356
357
358
359
360
361
362
363
364
365
366
367
/**
 * 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(),
368
    \Drupal::service('content_negotiation')->getContentType($request),
369
370
371
372
  );
  return sha1(implode(':', $cid_parts));
}

Dries's avatar
   
Dries committed
373
/**
374
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
375
 *
376
377
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request for this page.
378
 *
379
380
 * @return \Symfony\Component\HttpFoundation\Response
 *   The response, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
381
 */
382
function drupal_page_get_cache(Request $request) {
383
384
385
  $cache = \Drupal::cache('render')->get(drupal_page_cache_get_cid($request));
  if ($cache) {
    return $cache->data;
386
  }
387
388
389
}

/**
390
 * Determines the cacheability of the current page.
391
 *
392
393
394
395
396
 * Note: we do not serve cached pages to authenticated users, or to anonymous
 * users when $_SESSION is non-empty. $_SESSION may contain status messages
 * from a form submission, the contents of a shopping cart, or other user-
 * specific content that should not be cached and displayed to other users.
 *
397
 * @param $allow_caching
398
399
 *   Set to FALSE if you want to prevent this page to get cached.
 *
400
 * @return
401
 *   TRUE if the current page can be cached, FALSE otherwise.
402
403
404
405
406
 */
function drupal_page_is_cacheable($allow_caching = NULL) {
  $allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
  if (isset($allow_caching)) {
    $allow_caching_static = $allow_caching;
Dries's avatar
 
Dries committed
407
  }
408
409

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
410
    && PHP_SAPI !== 'cli';
Dries's avatar
 
Dries committed
411
412
}

413
/**
414
 * Sets an HTTP response header for the current page.
415
416
417
418
419
 *
 * 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
420
 *   The HTTP header name, or the special 'Status' header name.
421
 * @param $value
422
423
424
 *   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".
425
426
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
427
 *
428
429
430
 * @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.
431
 */
432
function drupal_add_http_header($name, $value, $append = FALSE) {
433
  // The headers as name/value pairs.
434
  $headers = &drupal_static('drupal_http_headers', array());
435

436
  $name_lower = strtolower($name);
437
  _drupal_set_preferred_header_name($name);
438

439
  if ($value === FALSE) {
440
    $headers[$name_lower] = FALSE;
441
  }
442
  elseif (isset($headers[$name_lower]) && $append) {
443
444
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
445
    $headers[$name_lower] .= ',' . $value;
446
447
  }
  else {
448
    $headers[$name_lower] = $value;
449
450
451
452
  }
}

/**
453
 * Gets the HTTP response headers for the current page.
454
455
456
457
 *
 * @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.
458
 *
459
460
461
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
462
 *
463
464
465
 * @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.
466
 */
467
function drupal_get_http_header($name = NULL) {
468
  $headers = &drupal_static('drupal_http_headers', array());
469
470
471
472
473
474
475
476
477
478
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
479
480
 * Sets the preferred name for the HTTP header.
 *
481
 * Header names are case-insensitive, but for maximum compatibility they should
482
483
 * follow "common form" (see RFC 2616, section 4.2).
 *
484
485
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
486
487
488
489
490
491
492
493
494
495
496
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

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

/**
497
498
499
500
 * 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().
501
 *
502
503
504
505
506
 * @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.
507
 *
508
509
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
510
511
512
 */
function drupal_send_headers($default_headers = array(), $only_default = FALSE) {
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
513
  $headers = drupal_get_http_header();
514
515
516
517
518
519
520
521
522
523
524
525
526
527
  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) {
528
    if ($name_lower == 'status') {
529
530
531
      header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
    }
    // Skip headers that have been unset.
532
    elseif ($value !== FALSE) {
533
534
535
536
537
      header($header_names[$name_lower] . ': ' . $value);
    }
  }
}

Dries's avatar
   
Dries committed
538
/**
539
 * Sets HTTP headers in preparation for a page response.
540
 *
541
542
543
544
 * 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.
 *
545
 * Also give each page a unique ETag. This should force clients to include both
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 * 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.
562
 *
563
 * @see drupal_page_set_cache()
564
 *
565
566
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
Dries's avatar
   
Dries committed
567
 */
Dries's avatar
 
Dries committed
568
function drupal_page_header() {
569
570
571
572
573
574
575
576
  $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',
577
    'Last-Modified' => gmdate(DateTimePlus::RFC7231, REQUEST_TIME),
578
579
580
581
    'Cache-Control' => 'no-cache, must-revalidate, post-check=0, pre-check=0',
    'ETag' => '"' . REQUEST_TIME . '"',
  );
  drupal_send_headers($default_headers);
582
}
Dries's avatar
   
Dries committed
583

584
/**
585
 * Sets HTTP headers in preparation for a cached page response.
586
 *
587
588
 * The headers allow as much as possible in proxies and browsers without any
 * particular knowledge about the pages. Modules can override these headers
589
 * using drupal_add_http_header().
590
 *
591
592
593
594
 * 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.
 */
595
596
597
598
599
600
601
602
603
604
605
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();
606
607
  }

608
609
610
611
  // 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
612
      // zlib.output_compression does not compress it once more.
613
      ini_set('zlib.output_compression', '0');
614
615
    }
    else {
616
617
618
619
620
621
      // 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');
622
    }
623
624
  }

625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
  // 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
648
649
}

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

/**
709
710
 * Formats a string for HTML display by replacing variable placeholders.
 *
711
 * @see \Drupal\Component\Utility\String::format()
712
713
714
715
 * @see t()
 * @ingroup sanitization
 */
function format_string($string, array $args = array()) {
716
  return String::format($string, $args);
717
718
}

Gábor Hojtsy's avatar
Gábor Hojtsy committed
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
/**
 * 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.
 *
734
735
 * 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
736
737
738
 *
 * @param $text
 *   The text to check.
739
 *
Gábor Hojtsy's avatar
Gábor Hojtsy committed
740
741
 * @return
 *   TRUE if the text is valid UTF-8, FALSE if not.
742
743
 *
 * @see \Drupal\Component\Utility\Unicode::validateUtf8()
Gábor Hojtsy's avatar
Gábor Hojtsy committed
744
745
 */
function drupal_validate_utf8($text) {
746
  return Unicode::validateUtf8($text);
Dries's avatar
Dries committed
747
748
}

Dries's avatar
   
Dries committed
749
/**
750
751
752
753
 * 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.
754
755
 *
 * @todo The above comment is incorrect: http://drupal.org/node/1547294.
Dries's avatar
   
Dries committed
756
 */
757
function request_uri($omit_query_string = FALSE) {
758
759
760
761
  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
762
    if (isset($_SERVER['argv'][0])) {
763
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
764
    }
765
    elseif (isset($_SERVER['QUERY_STRING'])) {
766
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
767
    }
768
769
770
    else {
      $uri = $_SERVER['SCRIPT_NAME'];
    }
Dries's avatar
 
Dries committed
771
  }
772
773
  // Prevent multiple slashes to avoid cross site requests via the Form API.
  $uri = '/' . ltrim($uri, '/');
774

775
  return $omit_query_string ? strtok($uri, '?') : $uri;
Dries's avatar
 
Dries committed
776
}
Dries's avatar
Dries committed
777

778
/**
779
 * Logs an exception.
780
781
782
783
784
785
786
787
788
789
 *
 * This is a wrapper function for watchdog() which automatically decodes an
 * exception.
 *
 * @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
790
 *   information about the passed-in exception is used.
791
 * @param $variables
792
793
794
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
795
796
797
798
799
800
 * @param $severity
 *   The severity of the message, as per RFC 3164.
 * @param $link
 *   A link to associate with the message.
 *
 * @see watchdog()
801
 * @see \Drupal\Core\Utility\Error::decodeException()
802
 */
803
function watchdog_exception($type, Exception $exception, $message = NULL, $variables = array(), $severity = WATCHDOG_ERROR, $link = NULL) {
804

805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
  // 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);
820
821
}

Dries's avatar
   
Dries committed
822
/**
823
 * Logs a system message.
Dries's avatar
   
Dries committed
824
825
 *
 * @param $type
826
827
 *   The category to which this message belongs. Can be any string, but the
 *   general practice is to use the name of the module calling watchdog().
Dries's avatar
   
Dries committed
828
 * @param $message
829
830
831
832
833
 *   The message to store in the log. Keep $message translatable
 *   by not concatenating dynamic values into it! Variables in the
 *   message should be added by using placeholder strings alongside
 *   the variables argument to declare the value of the placeholders.
 *   See t() for documentation on how $message and $variables interact.
834
 * @param $variables
835
836
 *   Array of variables to replace in the message on display or array() if
 *   message is already translated or not possible to translate.
837
 * @param $severity
838
839
840
841
842
843
844
845
846
847
 *   The severity of the message; one of the following values as defined in
 *   @link http://www.faqs.org/rfcs/rfc3164.html RFC 3164: @endlink
 *   - WATCHDOG_EMERGENCY: Emergency, system is unusable.
 *   - WATCHDOG_ALERT: Alert, action must be taken immediately.
 *   - WATCHDOG_CRITICAL: Critical conditions.
 *   - WATCHDOG_ERROR: Error conditions.
 *   - WATCHDOG_WARNING: Warning conditions.
 *   - WATCHDOG_NOTICE: (default) Normal but significant conditions.
 *   - WATCHDOG_INFO: Informational messages.
 *   - WATCHDOG_DEBUG: Debug-level messages.
Dries's avatar
   
Dries committed
848
849
 * @param $link
 *   A link to associate with the message.
850
 *
851
852
853
854
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::logger($channel)->log($severity, $message, $context), or any
 *   of the shortcut methods of \Psr\Log\LoggerTrait.
 *
855
 * @see watchdog_severity_levels()
856
 * @see hook_watchdog()
Dries's avatar
   
Dries committed
857
 */
858
859
860
function watchdog($type, $message, array $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
  if ($link) {
    $variables['link'] = $link;
861
  }
862
  \Drupal::service('logger.factory')->get($type)->log($severity, $message, $variables);
Dries's avatar
   
Dries committed
863
864
}

Dries's avatar
   
Dries committed
865
/**
866
 * Sets a message to display to the user.
Dries's avatar
   
Dries committed
867
 *
868
869
 * Messages are stored in a session variable and displayed in the page template
 * via the $messages theme variable.
Dries's avatar
   
Dries committed
870
 *
871
872
873
874
875
876
877
878
879
880
881
882
 * 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:
883
 *   - 'status'
884
 *   - 'warning'
885
 *   - 'error'
886
887
 * @param bool $repeat
 *   (optional) If this is FALSE and the message is already set, then the
888
 *   message won't be repeated. Defaults to FALSE.
889
890
891
 *
 * @return array|null
 *   A multidimensional array with keys corresponding to the set message types.
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 *   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.
913
914
915
 *
 * @see drupal_get_messages()
 * @see theme_status_messages()
Dries's avatar
   
Dries committed
916
 */
917
function drupal_set_message($message = NULL, $type = 'status', $repeat = FALSE) {
918
  if ($message) {
Dries's avatar
   
Dries committed
919
920
921
922
    if (!isset($_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type] = array();
    }

923
    if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
924
925
926
927
      $_SESSION['messages'][$type][] = array(
        'safe' => SafeMarkup::isSafe($message),
        'message' => $message,
      );
928
    }
929

930
    // Mark this page as being uncacheable.
931
    drupal_page_is_cacheable(FALSE);
932
933
  }

934
  // Messages not set when DB connection fails.
935
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
936
937
}

Dries's avatar
   
Dries committed
938
/**
939
 * Returns all messages that have been set with drupal_set_message().
Dries's avatar
   
Dries committed
940
 *
941
942
943
944
945
946
947
948
949
950
951
 * @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.
952
 *
953
 * @return array
954
955
956
957
958
 *   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
 *   drupal_set_message() for the array structure of indivdual messages.
959
960
961
 *
 * @see drupal_set_message()
 * @see theme_status_messages()
Dries's avatar
   
Dries committed
962
 */
963
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
964
  if ($messages = drupal_set_message()) {
965
966
967
968
969
970
971
972
    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'];
      }
    }
973
    if ($type) {
974
      if ($clear_queue) {
975
        unset($_SESSION['messages'][$type]);
976
      }
977
978
979
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
980
981
    }
    else {
982
      if ($clear_queue) {
983
        unset($_SESSION['messages']);
984
      }
985
986
      return $messages;
    }
987
  }
988
  return array();
989
990
}

991
/**
992
993
994
995
996
997
998
999
 * 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
1000
1001
 *
 * @param $phase
1002
 *   A constant telling which phase to bootstrap to. Possible values:
1003
 *   - DRUPAL_BOOTSTRAP_CONFIGURATION: Initializes configuration.
1004
 *   - DRUPAL_BOOTSTRAP_KERNEL: Initalizes a kernel.
1005
 *
1006
 * @return int
1007
 *   The most recently completed phase.
1008
1009
1010
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Interact directly with the kernel.
1011
 */
1012
function drupal_bootstrap($phase = NULL) {
1013
1014
1015
1016
1017
  // Temporary variables used for booting later legacy phases.
  /** @var \Drupal\Core\DrupalKernel $kernel */
  static $kernel;
  static $boot_level = 0;

1018
  if (isset($phase)) {
1019
1020
    $request = Request::createFromGlobals();
    for ($current_phase = $boot_level; $current_phase <= $phase; $current_phase++) {