bootstrap.inc 56.3 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

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

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

55 56 57 58 59 60
/**
 * @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
61
 * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
62
 * for use in the syslog() function, but their values on Windows builds do not
63
 * correspond to RFC 3164. The associated PHP bug report was closed with the
64 65 66 67 68 69 70 71 72 73 74 75 76 77
 * 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.
 */
78
const WATCHDOG_EMERGENCY = 0;
79 80 81 82

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
83
const WATCHDOG_ALERT = 1;
84 85

/**
86
 * Log message severity -- Critical conditions.
87
 */
88
const WATCHDOG_CRITICAL = 2;
89 90

/**
91
 * Log message severity -- Error conditions.
92
 */
93
const WATCHDOG_ERROR = 3;
94 95

/**
96
 * Log message severity -- Warning conditions.
97
 */
98
const WATCHDOG_WARNING = 4;
99 100

/**
101
 * Log message severity -- Normal but significant conditions.
102
 */
103
const WATCHDOG_NOTICE = 5;
104 105

/**
106
 * Log message severity -- Informational messages.
107
 */
108
const WATCHDOG_INFO = 6;
109 110

/**
111
 * Log message severity -- Debug-level messages.
112
 */
113
const WATCHDOG_DEBUG = 7;
114 115 116 117 118

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

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

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

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

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

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

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

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

164 165 166 167 168
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

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

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

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

/**
 * $config_directories key for staging directory.
 *
198
 * @see config_get_config_directory()
199 200 201
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

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

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

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

305 306 307 308 309 310 311 312
  // 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';
  }

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

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

354 355 356
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
357 358
}

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

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

/**
393
 * Determines the cacheability of the current page.
394
 *
395 396 397 398 399
 * 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.
 *
400
 * @param $allow_caching
401 402
 *   Set to FALSE if you want to prevent this page to get cached.
 *
403
 * @return
404
 *   TRUE if the current page can be cached, FALSE otherwise.
405 406 407 408 409
 */
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
410
  }
411 412

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

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

439
  $name_lower = strtolower($name);
440
  _drupal_set_preferred_header_name($name);
441

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

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

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

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

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

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

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

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

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

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

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

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

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

778
  return $omit_query_string ? strtok($uri, '?') : $uri;
Dries's avatar
 
Dries committed
779
}
Dries's avatar
Dries committed
780

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

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

Dries's avatar
 
Dries committed
825
/**
826
 * Logs a system message.
Dries's avatar
 
Dries committed
827 828
 *
 * @param $type
829 830
 *   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
831
 * @param $message
832 833 834 835 836
 *   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.
837
 * @param $variables
838 839
 *   Array of variables to replace in the message on display or array() if
 *   message is already translated or not possible to translate.
840
 * @param $severity
841 842 843 844 845 846 847 848 849 850
 *   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
851 852
 * @param $link
 *   A link to associate with the message.
853
 *
854 855 856 857
 * @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.
 *
858
 * @see watchdog_severity_levels()
859
 * @see hook_watchdog()
Dries's avatar
 
Dries committed
860
 */
861 862 863
function watchdog($type, $message, array $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
  if ($link) {
    $variables['link'] = $link;
864
  }
865
  \Drupal::service('logger.factory')->get($type)->log($severity, $message, $variables);
Dries's avatar
 
Dries committed
866 867
}

Dries's avatar
 
Dries committed
868
/**
869
 * Sets a message to display to the user.
Dries's avatar
 
Dries committed
870
 *
871 872
 * Messages are stored in a session variable and displayed in the page template
 * via the $messages theme variable.
Dries's avatar
 
Dries committed
873
 *
874 875 876 877 878 879 880 881 882 883 884 885
 * 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:
886
 *   - 'status'
887
 *   - 'warning'
888
 *   - 'error'
889 890
 * @param bool $repeat
 *   (optional) If this is FALSE and the message is already set, then the
891
 *   message won't be repeated. Defaults to FALSE.
892 893 894
 *
 * @return array|null
 *   A multidimensional array with keys corresponding to the set message types.
895 896 897 898 899 900 901