bootstrap.inc 117 KB
Newer Older
1
<?php
Dries's avatar
 
Dries committed
2

3
use Drupal\Component\Utility\NestedArray;
4
use Drupal\Core\DrupalKernel;
5
use Drupal\Core\Database\Database;
6
use Drupal\Core\DependencyInjection\ContainerBuilder;
7 8
use Symfony\Component\ClassLoader\UniversalClassLoader;
use Symfony\Component\ClassLoader\ApcUniversalClassLoader;
9
use Symfony\Component\DependencyInjection\Container;
katbailey's avatar
katbailey committed
10
use Symfony\Component\DependencyInjection\Reference;
11
use Symfony\Component\DependencyInjection\Exception\RuntimeException as DependencyInjectionRuntimeException;
12
use Symfony\Component\HttpFoundation\Request;
13
use Drupal\Core\Language\Language;
14 15
use Drupal\Core\Lock\DatabaseLockBackend;
use Drupal\Core\Lock\LockBackendInterface;
16

Dries's avatar
 
Dries committed
17 18 19 20
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
 
Dries committed
21

22 23 24
/**
 * The current system version.
 */
25
const VERSION = '8.0-dev';
26 27 28 29

/**
 * Core API compatibility.
 */
30
const DRUPAL_CORE_COMPATIBILITY = '8.x';
31 32 33 34

/**
 * Minimum supported version of PHP.
 */
35
const DRUPAL_MINIMUM_PHP = '5.3.5';
36 37 38 39

/**
 * Minimum recommended value of PHP memory_limit.
 */
40
const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '32M';
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 84
 * 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.
 */
85
const WATCHDOG_EMERGENCY = 0;
86 87 88 89

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

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

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

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

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

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

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

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

126 127 128
/**
 * First bootstrap phase: initialize configuration.
 */
129
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
130 131

/**
132
 * Second bootstrap phase, initalize a kernel.
133
 */
134
const DRUPAL_BOOTSTRAP_KERNEL = 1;
135 136

/**
137
 * Third bootstrap phase: try to serve a cached page.
138
 */
139
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
140 141

/**
142
 * Fourth bootstrap phase: initialize database layer.
143
 */
144
const DRUPAL_BOOTSTRAP_DATABASE = 3;
145 146

/**
147
 * Fifth bootstrap phase: initialize the variable system.
148
 */
149
const DRUPAL_BOOTSTRAP_VARIABLES = 4;
150 151

/**
152
 * Sixth bootstrap phase: initialize session handling.
153
 */
154
const DRUPAL_BOOTSTRAP_SESSION = 5;
155 156

/**
157
 * Seventh bootstrap phase: set up the page header.
158
 */
159 160 161 162 163 164
const DRUPAL_BOOTSTRAP_PAGE_HEADER = 6;

/**
 * Eighth bootstrap phase: load code for subsystems and modules.
 */
const DRUPAL_BOOTSTRAP_CODE = 7;
165 166

/**
167
 * Final bootstrap phase: initialize language, path, theme, and modules.
168
 */
169
const DRUPAL_BOOTSTRAP_FULL = 8;
170

171 172 173
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
174
const DRUPAL_ANONYMOUS_RID = 'anonymous';
175 176 177 178

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

181
/**
182 183 184
 * The number of bytes in a kilobyte.
 *
 * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
185
 */
186
const DRUPAL_KILOBYTE = 1024;
187

188
/**
189
 * Special system language code (only applicable to UI language).
190
 *
191 192 193 194
 * Refers to the language used in Drupal and module/theme source code. Drupal
 * uses the built-in text for English by default, but if configured to allow
 * translation/customization of English, we need to differentiate between the
 * built-in language and the English translation.
195
 */
196
const LANGUAGE_SYSTEM = 'system';
197

198
/**
199
 * The language code used when no language is explicitly assigned (yet).
200
 *
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
 * Should be used when language information is not available or cannot be
 * determined. This special language code is useful when we know the data
 * might have linguistic information, but we don't know the language.
 *
 * See http://www.w3.org/International/questions/qa-no-language#undetermined.
 */
const LANGUAGE_NOT_SPECIFIED = 'und';

/**
 * The language code used when the marked object has no linguistic content.
 *
 * Should be used when we explicitly know that the data referred has no
 * linguistic content.
 *
 * See http://www.w3.org/International/questions/qa-no-language#nonlinguistic.
 */
const LANGUAGE_NOT_APPLICABLE = 'zxx';

219 220 221 222 223 224 225 226
/**
 * Language code referring to the default language of data, e.g. of an entity.
 *
 * @todo: Change value to differ from LANGUAGE_NOT_SPECIFIED once field API
 * leverages the property API.
 */
const LANGUAGE_DEFAULT = 'und';

227
/**
228
 * The language state when referring to configurable languages.
229
 */
230 231 232 233 234 235 236 237 238 239 240
const LANGUAGE_CONFIGURABLE = 1;

/**
 * The language state when referring to locked languages.
 */
const LANGUAGE_LOCKED = 2;

/**
 * The language state used when referring to all languages.
 */
const LANGUAGE_ALL = 3;
241

242 243 244 245 246
/**
 * The language state used when referring to the site's default language.
 */
const LANGUAGE_SITE_DEFAULT = 4;

247
/**
248
 * The type of language used to define the content language.
249
 */
250
const LANGUAGE_TYPE_CONTENT = 'language_content';
251 252

/**
253
 * The type of language used to select the user interface.
254
 */
255
const LANGUAGE_TYPE_INTERFACE = 'language_interface';
256 257

/**
258
 * The type of language used for URLs.
259
 */
260
const LANGUAGE_TYPE_URL = 'language_url';
261

262 263 264
/**
 * Language written left to right. Possible value of $language->direction.
 */
265
const LANGUAGE_LTR = 0;
266 267 268 269

/**
 * Language written right to left. Possible value of $language->direction.
 */
270
const LANGUAGE_RTL = 1;
271

Dave Reid's avatar
Dave Reid committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
/**
 * Indicates an error during check for PHP unicode support.
 */
const UNICODE_ERROR = -1;

/**
 * Indicates that standard PHP (emulated) unicode support is being used.
 */
const UNICODE_SINGLEBYTE = 0;

/**
 * Indicates that full unicode support with the PHP mbstring extension is being
 * used.
 */
const UNICODE_MULTIBYTE = 1;

288
/**
289
 * Time of the current request in seconds elapsed since the Unix Epoch.
290
 *
291 292 293 294 295 296
 * 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
297
 */
298
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
299

300 301 302
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
303
const CHECK_PLAIN = 0;
304 305 306 307

/**
 * Flag for drupal_set_title(); text has already been sanitized.
 */
308
const PASS_THROUGH = -1;
309

310 311 312
/**
 * Regular expression to match PHP function names.
 *
313
 * @see http://php.net/manual/language.functions.php
314
 */
315
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
316

317 318 319
/**
 * $config_directories key for active directory.
 *
320
 * @see config_get_config_directory()
321 322 323 324 325 326
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
327
 * @see config_get_config_directory()
328 329 330
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

Dries's avatar
 
Dries committed
331
/**
332 333 334 335
 * Starts the timer with the specified name.
 *
 * If you start and stop the same timer multiple times, the measured intervals
 * will be accumulated.
Dries's avatar
 
Dries committed
336
 *
337
 * @param $name
Dries's avatar
 
Dries committed
338 339 340 341 342
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

343
  $timers[$name]['start'] = microtime(TRUE);
344
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
 
Dries committed
345 346 347
}

/**
348
 * Reads the current timer value without stopping the timer.
Dries's avatar
 
Dries committed
349
 *
350
 * @param $name
Dries's avatar
 
Dries committed
351
 *   The name of the timer.
352
 *
Dries's avatar
 
Dries committed
353 354 355 356 357 358
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

359
  if (isset($timers[$name]['start'])) {
360
    $stop = microtime(TRUE);
361
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
 
Dries committed
362

363 364 365 366
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
367
  }
368
  return $timers[$name]['time'];
Dries's avatar
 
Dries committed
369 370 371
}

/**
372
 * Stops the timer with the specified name.
Dries's avatar
 
Dries committed
373
 *
374
 * @param $name
Dries's avatar
 
Dries committed
375
 *   The name of the timer.
376
 *
Dries's avatar
 
Dries committed
377
 * @return
378 379
 *   A timer array. The array contains the number of times the timer has been
 *   started and stopped (count) and the accumulated timer value in ms (time).
Dries's avatar
 
Dries committed
380 381 382 383
 */
function timer_stop($name) {
  global $timers;

384 385 386 387 388 389 390 391 392 393
  if (isset($timers[$name]['start'])) {
    $stop = microtime(TRUE);
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
    if (isset($timers[$name]['time'])) {
      $timers[$name]['time'] += $diff;
    }
    else {
      $timers[$name]['time'] = $diff;
    }
    unset($timers[$name]['start']);
394
  }
Dries's avatar
 
Dries committed
395 396 397

  return $timers[$name];
}
398

Dries's avatar
 
Dries committed
399
/**
400
 * Returns the appropriate configuration directory.
Dries's avatar
 
Dries committed
401
 *
402 403 404 405
 * Returns the configuration path based on the site's hostname, port, and
 * pathname. Uses find_conf_path() to find the current configuration directory.
 * See default.settings.php for examples on how the URL is converted to a
 * directory.
406
 *
407
 * @param bool $require_settings
408 409 410 411
 *   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.
412
 * @param bool $reset
413
 *   Force a full search for matching directories even if one had been
414 415
 *   found previously. Defaults to FALSE.
 *
416 417
 * @return
 *   The path of the matching directory.
418 419
 *
 * @see default.settings.php
Dries's avatar
 
Dries committed
420
 */
421
function conf_path($require_settings = TRUE, $reset = FALSE) {
422
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
423

424
  if ($conf && !$reset) {
Dries's avatar
Dries committed
425 426
    return $conf;
  }
Dries's avatar
 
Dries committed
427

428 429 430 431 432
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
433
  $conf = find_conf_path($http_host, $script_name, $require_settings);
434 435 436 437 438 439
  return $conf;
}

/**
 * Finds the appropriate configuration directory for a given host and path.
 *
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
 * Finds a matching configuration directory file by stripping the website's
 * hostname from left to right and pathname from right to left. By default,
 * the directory must contain a 'settings.php' file for it to match. If the
 * parameter $require_settings is set to FALSE, then a directory without a
 * 'settings.php' file will match as well. The first configuration
 * file found will be used and the remaining ones will be ignored. If no
 * configuration file is found, returns a default value '$confdir/default'. See
 * default.settings.php for examples on how the URL is converted to a directory.
 *
 * If a file named sites.php is present in the $confdir, it will be loaded
 * prior to scanning for directories. That file can define aliases in an
 * associative array named $sites. The array is written in the format
 * '<port>.<domain>.<path>' => 'directory'. As an example, to create a
 * directory alias for http://www.drupal.org:8080/mysite/test whose configuration
 * file is in sites/example.com, the array should be defined as:
 * @code
 * $sites = array(
 *   '8080.www.drupal.org.mysite.test' => 'example.com',
 * );
 * @endcode
 *
461 462 463 464
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
465
 *   The part of the URL following the hostname, including the leading slash.
466 467 468
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
469 470 471 472
 *
 * @return
 *   The path of the matching configuration directory.
 *
473 474
 * @see default.settings.php
 * @see example.sites.php
475 476 477
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
478 479 480 481
  // Determine whether multi-site functionality is enabled.
  if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
    return 'sites/default';
  }
482 483

  $sites = array();
484
  include DRUPAL_ROOT . '/sites/sites.php';
485

486 487
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
488 489 490
  for ($i = count($uri) - 1; $i > 0; $i--) {
    for ($j = count($server); $j > 0; $j--) {
      $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
491
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
492 493
        $dir = $sites[$dir];
      }
494 495
      if (file_exists(DRUPAL_ROOT . '/sites/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/sites/' . $dir))) {
        return "sites/$dir";
Dries's avatar
Dries committed
496
      }
Dries's avatar
 
Dries committed
497 498
    }
  }
499
  return 'sites/default';
Dries's avatar
 
Dries committed
500 501
}

502
/**
503 504 505 506 507
 * 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.
508 509 510 511
 *
 * @return string
 *   The configuration directory path.
 */
512 513
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
514 515 516

  if ($test_prefix = drupal_valid_test_ua()) {
    // @see Drupal\simpletest\WebTestBase::setUp()
517 518 519
    $path = conf_path() . '/files/simpletest/' . substr($test_prefix, 10) . '/config_' . $type;
  }
  elseif (!empty($config_directories[$type])) {
520 521 522 523 524 525 526
    // Allow a configuration directory path to be outside of webroot.
    if (empty($config_directories[$type]['absolute'])) {
      $path = conf_path() . '/files/' . $config_directories[$type]['path'];
    }
    else {
      $path = $config_directories[$type]['path'];
    }
527 528
  }
  else {
529
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
530 531 532 533
  }
  return $path;
}

534
/**
535
 * Sets appropriate server variables needed for command line scripts to work.
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
 *
 * This function can be called by command line scripts before bootstrapping
 * Drupal, to ensure that the page loads with the desired server parameters.
 * This is because many parts of Drupal assume that they are running in a web
 * browser and therefore use information from the global PHP $_SERVER variable
 * that does not get set when Drupal is run from the command line.
 *
 * In many cases, the default way in which this function populates the $_SERVER
 * variable is sufficient, and it can therefore be called without passing in
 * any input. However, command line scripts running on a multisite installation
 * (or on any installation that has settings.php stored somewhere other than
 * the sites/default folder) need to pass in the URL of the site to allow
 * Drupal to detect the correct location of the settings.php file. Passing in
 * the 'url' parameter is also required for functions like request_uri() to
 * return the expected values.
 *
 * Most other parameters do not need to be passed in, but may be necessary in
 * some cases; for example, if Drupal's ip_address() function needs to return
 * anything but the standard localhost value ('127.0.0.1'), the command line
 * script should pass in the desired value via the 'REMOTE_ADDR' key.
 *
 * @param $variables
 *   (optional) An associative array of variables within $_SERVER that should
 *   be replaced. If the special element 'url' is provided in this array, it
 *   will be used to populate some of the server defaults; it should be set to
 *   the URL of the current page request, excluding any $_GET request but
 *   including the script name (e.g., http://www.example.com/mysite/index.php).
 *
 * @see conf_path()
 * @see request_uri()
 * @see ip_address()
 */
function drupal_override_server_variables($variables = array()) {
569
  // Allow the provided URL to override any existing values in $_SERVER.
570 571
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
572 573 574 575 576 577
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
578 579
    unset($variables['url']);
  }
580 581 582
  // Define default values for $_SERVER keys. These will be used if $_SERVER
  // does not already define them and no other values are passed in to this
  // function.
583
  $defaults = array(
584 585
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
586 587 588
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
589
    'SERVER_SOFTWARE' => NULL,
590 591 592 593 594 595
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

596
/**
597
 * Initializes the PHP environment.
598
 */
599
function drupal_environment_initialize() {
600 601
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
602
  }
603 604 605
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
606

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
  if (isset($_SERVER['HTTP_HOST'])) {
    // As HTTP_HOST is user input, ensure it only contains characters allowed
    // in hostnames. See RFC 952 (and RFC 2181).
    // $_SERVER['HTTP_HOST'] is lowercased here per specifications.
    $_SERVER['HTTP_HOST'] = strtolower($_SERVER['HTTP_HOST']);
    if (!drupal_valid_http_host($_SERVER['HTTP_HOST'])) {
      // HTTP_HOST is invalid, e.g. if containing slashes it may be an attack.
      header($_SERVER['SERVER_PROTOCOL'] . ' 400 Bad Request');
      exit;
    }
  }
  else {
    // Some pre-HTTP/1.1 clients will not send a Host header. Ensure the key is
    // defined for E_ALL compliance.
    $_SERVER['HTTP_HOST'] = '';
622 623
  }

624 625
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
626

627 628
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
629

630 631 632
  // Override PHP settings required for Drupal to work properly.
  // sites/default/default.settings.php contains more runtime settings.
  // The .htaccess file contains settings that cannot be changed at runtime.
633

Dave Reid's avatar
Dave Reid committed
634 635 636 637 638 639 640
  // Deny execution with enabled "magic quotes" (both GPC and runtime).
  if (get_magic_quotes_gpc() || get_magic_quotes_runtime()) {
    header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error');
    print "PHP's 'magic_quotes_gpc' and 'magic_quotes_runtime' settings are not supported and must be disabled.";
    exit;
  }

641 642
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
643
  ini_set('session.use_cookies', '1');
644
  ini_set('session.use_only_cookies', '1');
645
  ini_set('session.use_trans_sid', '0');
646
  // Don't send HTTP headers using PHP's session handler.
647 648
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
649 650
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
651 652 653 654

  // Set sane locale settings, to ensure consistent string, dates, times and
  // numbers handling.
  setlocale(LC_ALL, 'C');
Dave Reid's avatar
Dave Reid committed
655 656 657

  // Detect string handling method.
  unicode_check();
658 659
}

660
/**
661
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
662 663 664 665
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
666 667
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
668 669
}

Dave Reid's avatar
Dave Reid committed
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
/**
 * Checks for Unicode support in PHP and sets the proper settings if possible.
 *
 * Because Drupal needs to be able to handle text in various encodings, we do
 * not support mbstring function overloading. HTTP input/output conversion must
 * be disabled for similar reasons.
 *
 * @return string
 *   A string identifier of a failed multibyte extension check, if any.
 *   Otherwise, an empty string.
 */
function unicode_check() {
  global $multibyte;

  // Check for mbstring extension.
  if (!function_exists('mb_strlen')) {
    $multibyte = UNICODE_SINGLEBYTE;
    return 'mb_strlen';
  }

  // Check mbstring configuration.
  if (ini_get('mbstring.func_overload') != 0) {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.func_overload';
  }
  if (ini_get('mbstring.encoding_translation') != 0) {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.encoding_translation';
  }
  if (ini_get('mbstring.http_input') != 'pass') {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.http_input';
  }
  if (ini_get('mbstring.http_output') != 'pass') {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.http_output';
  }

  // Set appropriate configuration.
  mb_internal_encoding('utf-8');
  mb_language('uni');
  $multibyte = UNICODE_MULTIBYTE;
  return '';
}

715
/**
716
 * Sets the base URL, cookie domain, and session name from configuration.
717
 */
718
function drupal_settings_initialize() {
719
  global $base_url, $base_path, $base_root, $script_path;
720

721
  // Export these settings.php variables to the global namespace.
722
  global $databases, $cookie_domain, $conf, $installed_profile, $update_free_access, $class_loader, $db_url, $db_prefix, $drupal_hash_salt, $is_https, $base_secure_url, $base_insecure_url, $config_directories;
Dries's avatar
Dries committed
723 724
  $conf = array();

725 726
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
727
  if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
728
    include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
729
  }
730
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
731 732 733 734

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
735 736 737
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
738
    $base_path = $parts['path'] . '/';
739 740 741 742 743
    // Build $base_root (everything until first slash after "scheme://").
    $base_root = substr($base_url, 0, strlen($base_url) - strlen($parts['path']));
  }
  else {
    // Create base URL
744
    $http_protocol = $is_https ? 'https' : 'http';
745
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
746

747
    $base_url = $base_root;
748

749 750
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
751
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
752
      // Remove "core" directory if present, allowing install.php, update.php,
753
      // and others to auto-detect a base path.
754 755 756 757 758 759 760
      $core_position = strrpos($dir, '/core');
      if ($core_position !== FALSE && strlen($dir) - 5 == $core_position) {
        $base_path = substr($dir, 0, $core_position);
      }
      else {
        $base_path = $dir;
      }
761 762 763 764 765 766 767
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
768 769
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
770

771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
  // Determine the path of the script relative to the base path, and add a
  // trailing slash. This is needed for creating URLs to Drupal pages.
  if (!isset($script_path)) {
    $script_path = '';
    // We don't expect scripts outside of the base path, but sanity check
    // anyway.
    if (strpos($_SERVER['SCRIPT_NAME'], $base_path) === 0) {
      $script_path = substr($_SERVER['SCRIPT_NAME'], strlen($base_path)) . '/';
      // If the request URI does not contain the script name, then clean URLs
      // are in effect and the script path can be similarly dropped from URL
      // generation. For servers that don't provide $_SERVER['REQUEST_URI'], we
      // do not know the actual URI requested by the client, and request_uri()
      // returns a URI with the script name, resulting in non-clean URLs unless
      // there's other code that intervenes.
      if (strpos(request_uri(TRUE) . '/', $base_path . $script_path) !== 0) {
        $script_path = '';
      }
      // @todo Temporary BC for install.php, update.php, and other scripts.
      //   - http://drupal.org/node/1547184
      //   - http://drupal.org/node/1546082
      if ($script_path !== 'index.php/') {
        $script_path = '';
      }
    }
  }

797 798 799 800 801
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
802
    // Otherwise use $base_url as session name, without the protocol
803
    // to use the same session identifiers across HTTP and HTTPS.
804
    list( , $session_name) = explode('://', $base_url, 2);
805 806
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
807
    if (!empty($_SERVER['HTTP_HOST'])) {
808
      $cookie_domain = $_SERVER['HTTP_HOST'];
809 810 811 812 813 814 815
      // Strip leading periods, www., and port numbers from cookie domain.
      $cookie_domain = ltrim($cookie_domain, '.');
      if (strpos($cookie_domain, 'www.') === 0) {
        $cookie_domain = substr($cookie_domain, 4);
      }
      $cookie_domain = explode(':', $cookie_domain);
      $cookie_domain = '.' . $cookie_domain[0];
816 817 818 819 820 821 822
    }
  }
  // Per RFC 2109, cookie domains must contain at least one dot other than the
  // first. For hosts such as 'localhost' or IP Addresses we don't set a cookie domain.
  if (count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
    ini_set('session.cookie_domain', $cookie_domain);
  }
823 824 825 826 827 828 829 830 831 832
  // To prevent session cookies from being hijacked, a user can configure the
  // SSL version of their website to only transfer session cookies via SSL by
  // using PHP's session.cookie_secure setting. The browser will then use two
  // separate session cookies for the HTTPS and HTTP versions of the site. So we
  // must use different session identifiers for HTTPS and HTTP to prevent a
  // cookie collision.
  if ($is_https) {
    ini_set('session.cookie_secure', TRUE);
  }
  $prefix = ini_get('session.cookie_secure') ? 'SSESS' : 'SESS';
833
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
834 835
}

Dries's avatar
Dries committed
836
/**
837 838 839 840
 * 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
841
 *
Dries's avatar
Dries committed
842 843 844 845 846
 * 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
 * configuration. For example, a module 'foo' may legally be be located
 * in any of these three places:
 *
847
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
848 849 850 851 852 853
 * modules/foo/foo.module
 * sites/example.com/modules/foo/foo.module
 *
 * 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
854
 * @param $type
855
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
856 857 858 859 860 861 862 863 864
 * @param $name
 *   The name of the item for which the filename is requested.
 * @param $filename
 *   The filename of the item if it is to be set explicitly rather
 *   than by consulting the database.
 *
 * @return
 *   The filename of the requested item.
 */
Dries's avatar
Dries committed
865
function drupal_get_filename($type, $name, $filename = NULL) {
866 867
  // The location of files will not change during the request, so do not use
  // drupal_static().
868
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
869

870 871 872
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
873
  if ($type == 'profile') {
874
    $type = 'module';
875
  }
876
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
877 878 879
    $files[$type] = array();
  }

880
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
881 882
    $files[$type][$name] = $filename;
  }
883
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
884 885 886
    // nothing
  }
  else {
887 888 889
    // Verify that we have an keyvalue service before using it. This is required
    // because this function is called during installation.
    // @todo Inject database connection into KeyValueStore\DatabaseStorage.
890
    if (($container = drupal_container()) && $container->has('keyvalue') && function_exists('db_query')) {
891 892 893 894
      try {
        $file_list = state()->get('system.' . $type . '.files');
        if ($file_list && isset($file_list[$name]) && file_exists(DRUPAL_ROOT . '/' . $file_list[$name])) {
          $files[$type][$name] = $file_list[$name];
895
        }
896
      }
897 898 899 900 901
      catch (Exception $e) {
        // The keyvalue service raised an exception because the backend might
        // be down. We have a fallback for this case so we hide the error
        // completely.
      }
902 903 904 905
    }
    // Fallback to searching the filesystem if the database could not find the
    // file or the file returned by the database is not found.
    if (!isset($files[$type][$name])) {
906
      // We have consistent directory naming: modules, themes...
907 908 909
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
910
        $extension = 'engine';
911 912
      }
      elseif ($type == 'theme') {
913
        $extension = 'info';
914
      }
915 916 917 918 919 920
      // Profiles are converted into modules in system_rebuild_module_data().
      // @todo Remove false-exposure of profiles as modules.
      elseif ($original_type == 'profile') {
        $dir = 'profiles';
        $extension = 'profile';
      }
921
      else {
922
        $extension = $type;
923 924
      }

925 926 927
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
928
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
929 930 931 932 933
        }
        // Scan the appropriate directories for all files with the requested
        // extension, not just the file we are currently looking for. This
        // prevents unnecessary scans from being repeated when this function is
        // called more than once in the same page request.
934
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
935 936 937
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
938 939 940 941
      }
    }
  }