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

3
use Drupal\Core\Database\Database;
4 5
use Symfony\Component\ClassLoader\UniversalClassLoader;
use Symfony\Component\ClassLoader\ApcUniversalClassLoader;
6
use Drupal\Core\DependencyInjection\ContainerBuilder;
7
use Symfony\Component\HttpFoundation\Request;
8

Dries's avatar
 
Dries committed
9 10 11 12
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
 
Dries committed
13

14 15 16
/**
 * The current system version.
 */
17
const VERSION = '8.0-dev';
18 19 20 21

/**
 * Core API compatibility.
 */
22
const DRUPAL_CORE_COMPATIBILITY = '8.x';
23 24 25 26

/**
 * Minimum supported version of PHP.
 */
27
const DRUPAL_MINIMUM_PHP = '5.3.3';
28 29 30 31

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

34
/**
35 36
 * Indicates that the item should never be removed unless explicitly selected.
 *
37
 * The item may be removed using cache()->delete() with a cache ID.
38
 */
39
const CACHE_PERMANENT = 0;
40 41 42 43

/**
 * Indicates that the item should be removed at the next general cache wipe.
 */
44
const CACHE_TEMPORARY = -1;
Dries's avatar
 
Dries committed
45

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

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
74
const WATCHDOG_ALERT = 1;
75 76

/**
77
 * Log message severity -- Critical conditions.
78
 */
79
const WATCHDOG_CRITICAL = 2;
80 81

/**
82
 * Log message severity -- Error conditions.
83
 */
84
const WATCHDOG_ERROR = 3;
85 86

/**
87
 * Log message severity -- Warning conditions.
88
 */
89
const WATCHDOG_WARNING = 4;
90 91

/**
92
 * Log message severity -- Normal but significant conditions.
93
 */
94
const WATCHDOG_NOTICE = 5;
95 96

/**
97
 * Log message severity -- Informational messages.
98
 */
99
const WATCHDOG_INFO = 6;
100 101

/**
102
 * Log message severity -- Debug-level messages.
103
 */
104
const WATCHDOG_DEBUG = 7;
105 106 107 108 109

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

110 111 112
/**
 * First bootstrap phase: initialize configuration.
 */
113
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
114 115

/**
116
 * Second bootstrap phase: try to serve a cached page.
117
 */
118
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 1;
119 120 121 122

/**
 * Third bootstrap phase: initialize database layer.
 */
123
const DRUPAL_BOOTSTRAP_DATABASE = 2;
124 125

/**
126
 * Fourth bootstrap phase: initialize the variable system.
127
 */
128
const DRUPAL_BOOTSTRAP_VARIABLES = 3;
129 130

/**
131
 * Fifth bootstrap phase: initialize session handling.
132
 */
133
const DRUPAL_BOOTSTRAP_SESSION = 4;
134 135

/**
136
 * Sixth bootstrap phase: set up the page header.
137
 */
138
const DRUPAL_BOOTSTRAP_PAGE_HEADER = 5;
139 140

/**
141 142
 * Seventh bootstrap phase: load code for subsystems and modules; validate and
 * fix input data.
143
 */
144
const DRUPAL_BOOTSTRAP_CODE = 6;
145 146

/**
147
 * Final bootstrap phase: initialize language, path, theme, and modules.
148
 */
149
const DRUPAL_BOOTSTRAP_FULL = 7;
150

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

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

161
/**
162 163 164
 * The number of bytes in a kilobyte.
 *
 * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
165
 */
166
const DRUPAL_KILOBYTE = 1024;
167

168
/**
169
 * Special system language code (only applicable to UI language).
170
 *
171 172 173 174
 * 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.
175
 */
176
const LANGUAGE_SYSTEM = 'system';
177

178
/**
179
 * The language code used when no language is explicitly assigned (yet).
180
 *
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
 * 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';

/**
 * The language code used when multiple languages could be applied.
 *
 * Should be used when individual parts of the data cannot be marked with
 * language, but we know there are multiple languages involved. Such as a
 * PDF file for an electronic appliance, which has usage manuals in 8
 * languages but is uploaded as one file in Drupal.
 *
 * Defined by ISO639-2 for "Multiple languages".
208
 */
209
const LANGUAGE_MULTIPLE = 'mul';
210

211
/**
212
 * The type of language used to define the content language.
213
 */
214
const LANGUAGE_TYPE_CONTENT = 'language_content';
215 216

/**
217
 * The type of language used to select the user interface.
218
 */
219
const LANGUAGE_TYPE_INTERFACE = 'language_interface';
220 221

/**
222
 * The type of language used for URLs.
223
 */
224
const LANGUAGE_TYPE_URL = 'language_url';
225

226 227 228
/**
 * Language written left to right. Possible value of $language->direction.
 */
229
const LANGUAGE_LTR = 0;
230 231 232 233

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

236
/**
237
 * Time of the current request in seconds elapsed since the Unix Epoch.
238
 *
239 240 241 242 243 244
 * 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
245
 */
246
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
247

248 249 250
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
251
const CHECK_PLAIN = 0;
252 253 254 255

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

258
/**
259
 * Signals that the registry lookup cache should be reset.
260
 */
261
const REGISTRY_RESET_LOOKUP_CACHE = 1;
262 263

/**
264
 * Signals that the registry lookup cache should be written to storage.
265
 */
266
const REGISTRY_WRITE_LOOKUP_CACHE = 2;
267

268 269 270
/**
 * Regular expression to match PHP function names.
 *
271
 * @see http://php.net/manual/language.functions.php
272
 */
273
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
274

gdd's avatar
gdd committed
275
require_once DRUPAL_ROOT . '/core/includes/config.inc';
276

Dries's avatar
 
Dries committed
277
/**
278 279 280 281
 * 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
282
 *
283
 * @param $name
Dries's avatar
 
Dries committed
284 285 286 287 288
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

289
  $timers[$name]['start'] = microtime(TRUE);
290
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
 
Dries committed
291 292 293
}

/**
294
 * Reads the current timer value without stopping the timer.
Dries's avatar
 
Dries committed
295
 *
296
 * @param $name
Dries's avatar
 
Dries committed
297
 *   The name of the timer.
298
 *
Dries's avatar
 
Dries committed
299 300 301 302 303 304
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

305
  if (isset($timers[$name]['start'])) {
306
    $stop = microtime(TRUE);
307
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
 
Dries committed
308

309 310 311 312
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
313
  }
314
  return $timers[$name]['time'];
Dries's avatar
 
Dries committed
315 316 317
}

/**
318
 * Stops the timer with the specified name.
Dries's avatar
 
Dries committed
319
 *
320
 * @param $name
Dries's avatar
 
Dries committed
321
 *   The name of the timer.
322
 *
Dries's avatar
 
Dries committed
323
 * @return
324 325
 *   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
326 327 328 329
 */
function timer_stop($name) {
  global $timers;

330 331 332 333 334 335 336 337 338 339
  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']);
340
  }
Dries's avatar
 
Dries committed
341 342 343

  return $timers[$name];
}
344

Dries's avatar
 
Dries committed
345
/**
346
 * Finds the appropriate configuration directory.
Dries's avatar
 
Dries committed
347
 *
348
 * Finds a matching configuration directory by stripping the website's
349
 * hostname from left to right and pathname from right to left. The first
350 351
 * configuration file found will be used and the remaining ones will be ignored.
 * If no configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
352
 *
353 354
 * With a site located at http://www.example.com:8080/mysite/test/, the file,
 * settings.php, is searched for in the following directories:
Dries's avatar
 
Dries committed
355
 *
356 357 358 359
 * - $confdir/8080.www.example.com.mysite.test
 * - $confdir/www.example.com.mysite.test
 * - $confdir/example.com.mysite.test
 * - $confdir/com.mysite.test
Dries's avatar
 
Dries committed
360
 *
361 362 363 364
 * - $confdir/8080.www.example.com.mysite
 * - $confdir/www.example.com.mysite
 * - $confdir/example.com.mysite
 * - $confdir/com.mysite
Dries's avatar
 
Dries committed
365
 *
366 367 368 369
 * - $confdir/8080.www.example.com
 * - $confdir/www.example.com
 * - $confdir/example.com
 * - $confdir/com
Dries's avatar
 
Dries committed
370
 *
371
 * - $confdir/default
372
 *
373
 * If a file named sites.php is present in the $confdir, it will be loaded
374 375
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
376
 * of:
377
 * @code
378 379 380
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
381
 * @endcode
382
 * For example:
383
 * @code
384 385
 * $sites = array(
 *   'devexample.com' => 'example.com',
386
 *   'localhost.example' => 'example.com',
387
 * );
388
 * @endcode
389 390 391 392
 * The above array will cause Drupal to look for a directory named
 * "example.com" in the sites directory whenever a request comes from
 * "example.com", "devexample.com", or "localhost/example". That is useful
 * on development servers, where the domain name may not be the same as the
393
 * domain of the live server. Since Drupal stores file paths into the database
394 395 396
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
397
 * @param bool $require_settings
398 399 400 401
 *   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.
402
 * @param bool $reset
403
 *   Force a full search for matching directories even if one had been
404 405
 *   found previously. Defaults to FALSE.
 *
406 407
 * @return
 *   The path of the matching directory.
Dries's avatar
 
Dries committed
408
 */
409
function conf_path($require_settings = TRUE, $reset = FALSE) {
410
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
411

412
  if ($conf && !$reset) {
Dries's avatar
Dries committed
413 414
    return $conf;
  }
Dries's avatar
 
Dries committed
415

416 417 418 419 420
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
421
  $conf = find_conf_path($http_host, $script_name, $require_settings);
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
  return $conf;
}

/**
 * Finds the appropriate configuration directory for a given host and path.
 *
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
 *   The part of the url following the hostname, including the leading slash.
 *
 * @return
 *   The path of the matching configuration directory.
 *
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
Dries's avatar
 
Dries committed
440
  $confdir = 'sites';
441 442 443 444 445 446 447

  $sites = array();
  if (file_exists(DRUPAL_ROOT . '/' . $confdir . '/sites.php')) {
    // This will overwrite $sites with the desired mappings.
    include(DRUPAL_ROOT . '/' . $confdir . '/sites.php');
  }

448 449
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
450 451 452
  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));
453 454 455 456
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $sites[$dir])) {
        $dir = $sites[$dir];
      }
      if (file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $dir))) {
Dries's avatar
Dries committed
457 458 459
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
460 461
    }
  }
Dries's avatar
Dries committed
462 463
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
464 465
}

466
/**
467
 * Sets appropriate server variables needed for command line scripts to work.
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
 *
 * 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()) {
501
  // Allow the provided URL to override any existing values in $_SERVER.
502 503
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
504 505 506 507 508 509
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
510 511
    unset($variables['url']);
  }
512 513 514
  // 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.
515
  $defaults = array(
516 517
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
518 519 520
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
521
    'SERVER_SOFTWARE' => NULL,
522 523 524 525 526 527
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

528
/**
529
 * Initializes the PHP environment.
530
 */
531
function drupal_environment_initialize() {
532 533
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
534
  }
535 536 537
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
538

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
  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'] = '';
554 555
  }

556 557
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
558

559 560
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
561

562 563 564
  // 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.
565

566
  // Don't escape quotes when reading files from the database, disk, etc.
567
  ini_set('magic_quotes_runtime', '0');
568 569
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
570
  ini_set('session.use_cookies', '1');
571
  ini_set('session.use_only_cookies', '1');
572
  ini_set('session.use_trans_sid', '0');
573
  // Don't send HTTP headers using PHP's session handler.
574 575
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
576 577
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
578 579 580 581

  // Set sane locale settings, to ensure consistent string, dates, times and
  // numbers handling.
  setlocale(LC_ALL, 'C');
582 583
}

584
/**
585
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
586 587 588 589
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
590 591
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
592 593
}

594
/**
595
 * Sets the base URL, cookie domain, and session name from configuration.
596
 */
597
function drupal_settings_initialize() {
598
  global $base_url, $base_path, $base_root, $script_path;
599

Dries's avatar
Dries committed
600
  // Export the following settings.php variables to the global namespace
601
  global $databases, $cookie_domain, $conf, $installed_profile, $update_free_access, $db_url, $db_prefix, $drupal_hash_salt, $is_https, $base_secure_url, $base_insecure_url, $config_directory_name;
Dries's avatar
Dries committed
602 603
  $conf = array();

604 605
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
606
  }
607
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
608 609 610 611

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
612
    $http_protocol = $parts['scheme'];
613 614 615
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
616
    $base_path = $parts['path'] . '/';
617 618 619 620 621
    // 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
622
    $http_protocol = $is_https ? 'https' : 'http';
623
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
624

625
    $base_url = $base_root;
626

627 628
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
629
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
630
      // Remove "core" directory if present, allowing install.php, update.php,
631
      // and others to auto-detect a base path.
632 633 634 635 636 637 638
      $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;
      }
639 640 641 642 643 644 645
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
646 647
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
648

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
  // 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 = '';
      }
    }
  }

675 676 677 678 679
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
680 681 682
    // Otherwise use $base_url as session name, without the protocol
    // to use the same session identifiers across http and https.
    list( , $session_name) = explode('://', $base_url, 2);
683 684
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
685
    if (!empty($_SERVER['HTTP_HOST'])) {
686
      $cookie_domain = $_SERVER['HTTP_HOST'];
687 688 689 690 691 692 693
      // 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];
694 695 696 697 698 699 700
    }
  }
  // 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);
  }
701 702 703 704 705 706 707 708 709 710
  // 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';
711
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
712 713
}

Dries's avatar
Dries committed
714
/**
715 716 717 718
 * 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
719
 *
Dries's avatar
Dries committed
720 721 722 723 724 725 726 727 728 729 730 731
 * 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:
 *
 * modules/foo/foo.module
 * sites/all/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
732
 * @param $type
733
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
734 735 736 737 738 739 740 741 742
 * @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
743
function drupal_get_filename($type, $name, $filename = NULL) {
744 745
  // The location of files will not change during the request, so do not use
  // drupal_static().
746
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
747

748 749 750 751 752
  // Profiles are a special case: they have a fixed location and naming.
  if ($type == 'profile') {
    $profile_filename = "profiles/$name/$name.profile";
    $files[$type][$name] = file_exists($profile_filename) ? $profile_filename : FALSE;
  }
753
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
754 755 756
    $files[$type] = array();
  }

757
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
758 759
    $files[$type][$name] = $filename;
  }
760
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
761 762
    // nothing
  }
Dries's avatar
Dries committed
763
  // Verify that we have an active database connection, before querying
764
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
765 766
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
767
  else {
768
    try {
769 770
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
771
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
772 773
          $files[$type][$name] = $file;
        }
774 775
      }
    }
776
    catch (Exception $e) {
777 778 779 780 781 782 783 784 785 786 787
      // The database table may not exist because Drupal is not yet installed,
      // or the database might be down. We have a fallback for this case so we
      // hide the error completely.
    }
    // 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])) {
      // We have a consistent directory naming: modules, themes...
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
788
        $extension = 'engine';
789 790
      }
      elseif ($type == 'theme') {
791
        $extension = 'info';
792 793
      }
      else {
794
        $extension = $type;
795 796
      }

797 798 799
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
800
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
801 802 803 804 805 806 807 808 809
        }
        // 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.
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir, 'name', 0);
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
810 811 812 813
      }
    }
  }

814 815 816
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
817 818
}

Dries's avatar
 
Dries committed
819
/**
820
 * Loads the persistent variable table.
Dries's avatar
 
Dries committed
821 822
 *
 * The variable table is composed of values that have been saved in the table
823 824
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
 
Dries committed
825
 */
826
function variable_initialize($conf = array()) {
827 828
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
829
  if ($cached = cache('bootstrap')->get('variables')) {
830
    $variables = $cached->data;
Dries's avatar
 
Dries committed
831 832
  }
  else {
833 834 835 836 837 838 839 840 841 842 843
    // Cache miss. Avoid a stampede.
    $name = 'variable_init';
    if (!lock_acquire($name, 1)) {
      // Another request is building the variable cache.
      // Wait, then re-run this function.
      lock_wait($name);
      return variable_initialize($conf);
    }
    else {
      // Proceed with variable rebuild.
      $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
844
      cache('bootstrap')->set('variables', $variables);
845 846
      lock_release($name);
    }
Dries's avatar
 
Dries committed
847 848 849 850
  }

  foreach ($conf as $name => $value) {
    $variables[$name] = $value;
Dries's avatar
 
Dries committed
851 852
  }

Dries's avatar
 
Dries committed
853
  return $variables;
Dries's avatar
 
Dries committed
854 855
}

Dries's avatar
 
Dries committed
856
/**
857 858 859 860 861
 * Returns a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
 
Dries committed
862 863 864 865 866
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
867
 *
Dries's avatar
 
Dries committed
868
 * @return
869
 *   The value of the variable. Unserialization is taken care of as necessary.
870
 *
871 872
 * @see variable_del()
 * @see variable_set()
Dries's avatar
 
Dries committed
873
 */
874
function variable_get($name,