bootstrap.inc 101 KB
Newer Older
1
<?php
Dries's avatar
   
Dries committed
2
// $Id$
Dries's avatar
   
Dries committed
3

Dries's avatar
   
Dries committed
4
5
6
7
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
   
Dries committed
8

9
10
11
/**
 * The current system version.
 */
webchick's avatar
webchick committed
12
define('VERSION', '7.0-dev');
13
14
15
16
17
18
19
20
21

/**
 * Core API compatibility.
 */
define('DRUPAL_CORE_COMPATIBILITY', '7.x');

/**
 * Minimum supported version of PHP.
 */
22
define('DRUPAL_MINIMUM_PHP',    '5.2.0');
23
24
25
26

/**
 * Minimum recommended value of PHP memory_limit.
 */
27
define('DRUPAL_MINIMUM_PHP_MEMORY_LIMIT',    '40M');
28
29
30
31

/**
 * Minimum supported version of MySQL, if it is used.
 */
32
define('DRUPAL_MINIMUM_MYSQL',  '5.0.15');
33
34
35
36
37
38

/**
 * Minimum supported version of PostgreSQL, if it is used.
 */
define('DRUPAL_MINIMUM_PGSQL',  '8.3');

39
/**
40
41
42
 * Indicates that the item should never be removed unless explicitly selected.
 *
 * The item may be removed using cache_clear_all() with a cache ID.
43
 */
44
define('CACHE_PERMANENT', 0);
45
46
47
48

/**
 * Indicates that the item should be removed at the next general cache wipe.
 */
49
define('CACHE_TEMPORARY', -1);
Dries's avatar
   
Dries committed
50

51
/**
52
 * Log message severity -- Emergency: system is unusable.
53
 *
54
55
56
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
57
58
 * @see watchdog()
 * @see watchdog_severity_levels()
59
 */
60
define('WATCHDOG_EMERGENCY', 0);
61
62
63
64

/**
 * Log message severity -- Alert: action must be taken immediately.
 *
65
66
67
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
68
69
70
71
72
73
74
75
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_ALERT', 1);

/**
 * Log message severity -- Critical: critical conditions.
 *
76
77
78
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
79
80
81
82
83
84
85
86
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_CRITICAL', 2);

/**
 * Log message severity -- Error: error conditions.
 *
87
88
89
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
90
91
92
93
94
95
96
97
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_ERROR', 3);

/**
 * Log message severity -- Warning: warning conditions.
 *
98
99
100
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
101
102
103
104
105
106
107
108
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_WARNING', 4);

/**
 * Log message severity -- Notice: normal but significant condition.
 *
109
110
111
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
112
113
114
115
116
117
118
119
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_NOTICE', 5);

/**
 * Log message severity -- Informational: informational messages.
 *
120
121
122
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
123
124
125
126
127
128
129
130
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_INFO', 6);

/**
 * Log message severity -- Debug: debug-level messages.
 *
131
132
133
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
134
135
136
137
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_DEBUG', 7);
138

139
140
141
/**
 * First bootstrap phase: initialize configuration.
 */
142
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
143
144

/**
145
 * Second bootstrap phase: try to serve a cached page.
146
 */
147
define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 1);
148
149
150
151

/**
 * Third bootstrap phase: initialize database layer.
 */
152
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
153
154

/**
155
 * Fourth bootstrap phase: initialize the variable system.
156
 */
157
define('DRUPAL_BOOTSTRAP_VARIABLES', 3);
158
159

/**
160
 * Fifth bootstrap phase: initialize session handling.
161
 */
162
define('DRUPAL_BOOTSTRAP_SESSION', 4);
163
164

/**
165
 * Sixth bootstrap phase: set up the page header.
166
 */
167
define('DRUPAL_BOOTSTRAP_PAGE_HEADER', 5);
168
169

/**
170
 * Seventh bootstrap phase: find out language of the page.
171
 */
172
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);
173
174
175
176
177

/**
 * Final bootstrap phase: Drupal is fully loaded; validate and fix
 * input data.
 */
178
define('DRUPAL_BOOTSTRAP_FULL', 7);
179

180
181
182
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
183
define('DRUPAL_ANONYMOUS_RID', 1);
184
185
186
187

/**
 * Role ID for authenticated users; should match what's in the "role" table.
 */
188
189
define('DRUPAL_AUTHENTICATED_RID', 2);

190
/**
191
 * The number of bytes in a kilobyte. For more information, visit
192
193
194
195
 * http://en.wikipedia.org/wiki/Kilobyte.
 */
define('DRUPAL_KILOBYTE', 1024);

196
197
198
/**
 * The language code used when no language is explicitly assigned.
 *
199
 * Defined by ISO639-2 for "Undetermined".
200
 */
201
define('LANGUAGE_NONE', 'und');
202

203
/**
204
 * The type of language used to define the content language.
205
 */
206
define('LANGUAGE_TYPE_CONTENT', 'language_content');
207
208

/**
209
 * The type of language used to select the user interface.
210
 */
211
define('LANGUAGE_TYPE_INTERFACE', 'language');
212
213

/**
214
 * The type of language used for URLs.
215
 */
216
define('LANGUAGE_TYPE_URL', 'language_url');
217

218
219
220
221
222
223
224
225
226
227
/**
 * Language written left to right. Possible value of $language->direction.
 */
define('LANGUAGE_LTR', 0);

/**
 * Language written right to left. Possible value of $language->direction.
 */
define('LANGUAGE_RTL', 1);

228
229
230
/**
 * For convenience, define a short form of the request time global.
 */
231
define('REQUEST_TIME', $_SERVER['REQUEST_TIME']);
232

233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/**
 * @name Title text filtering flags
 * @{
 * Flags for use in drupal_set_title().
 */

/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
define('CHECK_PLAIN', 0);

/**
 * Flag for drupal_set_title(); text has already been sanitized.
 */
define('PASS_THROUGH', -1);

249
250
251
252
/**
 * @} End of "Title text filtering flags".
 */

253
/**
254
 * Signals that the registry lookup cache should be reset.
255
256
257
258
 */
define('REGISTRY_RESET_LOOKUP_CACHE', 1);

/**
259
 * Signals that the registry lookup cache should be written to storage.
260
261
262
 */
define('REGISTRY_WRITE_LOOKUP_CACHE', 2);

Dries's avatar
   
Dries committed
263
/**
264
265
 * Start 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
266
267
268
269
270
271
272
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

273
  $timers[$name]['start'] = microtime(TRUE);
274
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
275
276
277
278
279
280
281
282
283
284
285
286
287
}

/**
 * Read the current timer value without stopping the timer.
 *
 * @param name
 *   The name of the timer.
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

288
  if (isset($timers[$name]['start'])) {
289
    $stop = microtime(TRUE);
290
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
291

292
293
294
295
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
296
  }
297
  return $timers[$name]['time'];
Dries's avatar
   
Dries committed
298
299
300
301
302
303
304
305
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
306
307
 *   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
308
309
310
311
 */
function timer_stop($name) {
  global $timers;

312
313
314
315
316
317
318
319
320
321
  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']);
322
  }
Dries's avatar
   
Dries committed
323
324
325

  return $timers[$name];
}
326

Dries's avatar
   
Dries committed
327
/**
328
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
329
 *
330
331
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
332
 * configuration file found will be used; the remaining will ignored. If no
333
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
334
 *
335
 * Example for a fictitious site installed at
336
337
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
338
 *
339
340
341
342
 *  1. $confdir/8080.www.drupal.org.mysite.test
 *  2. $confdir/www.drupal.org.mysite.test
 *  3. $confdir/drupal.org.mysite.test
 *  4. $confdir/org.mysite.test
Dries's avatar
   
Dries committed
343
 *
344
345
346
347
 *  5. $confdir/8080.www.drupal.org.mysite
 *  6. $confdir/www.drupal.org.mysite
 *  7. $confdir/drupal.org.mysite
 *  8. $confdir/org.mysite
Dries's avatar
   
Dries committed
348
 *
349
350
351
352
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
353
 *
354
 * 13. $confdir/default
355
 *
356
 * If a file named sites.php is present in the $confdir, it will be loaded
357
358
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
359
360
361
362
363
364
365
366
367
368
 * of:
 *
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
 *
 * For example:
 *
 * $sites = array(
 *   'devexample.com' => 'example.com',
369
 *   'localhost.example' => 'example.com',
370
371
372
373
374
375
 * );
 *
 * 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
376
 * domain of the live server. Since Drupal stores file paths into the database
377
378
379
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
380
381
382
383
384
385
386
387
388
389
 * @param $require_settings
 *   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.
 * @param reset
 *   Force a full search for matching directories even if one had been
 *   found previously.
 * @return
 *   The path of the matching directory.
Dries's avatar
   
Dries committed
390
 */
391
function conf_path($require_settings = TRUE, $reset = FALSE) {
392
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
   
Dries committed
393

394
  if ($conf && !$reset) {
Dries's avatar
Dries committed
395
396
    return $conf;
  }
Dries's avatar
   
Dries committed
397

Dries's avatar
   
Dries committed
398
  $confdir = 'sites';
399
400
401
402
403
404
405

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

406
  $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
407
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
408
409
410
  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));
411
412
413
414
      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
415
416
417
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
   
Dries committed
418
419
    }
  }
Dries's avatar
Dries committed
420
421
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
   
Dries committed
422
423
}

424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
/**
 * Set appropriate server variables needed for command line scripts to work.
 *
 * 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()) {
  // Set defaults based on the provided URL.
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
    unset($variables['url']);
  }
  else {
    $url = array();
  }
  $url += array(
    'path' => '',
    'host' => 'localhost',
  );
  $defaults = array(
    'HTTP_HOST' => $url['host'],
    'SCRIPT_NAME' => $url['path'],
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
477
    'SERVER_SOFTWARE' => NULL,
478
479
480
481
482
483
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

484
/**
485
 * Initialize PHP environment.
486
 */
487
function drupal_environment_initialize() {
488
489
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
490
  }
491
492
493
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
494

495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
  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'] = '';
510
511
  }

512
513
514
515
516
517
518
  // When clean URLs are enabled, emulate ?q=foo/bar using REQUEST_URI. It is
  // not possible to append the query string using mod_rewrite without the B
  // flag (this was added in Apache 2.2.8), because mod_rewrite unescapes the
  // path before passing it on to PHP. This is a problem when the path contains
  // e.g. "&" or "%" that have special meanings in URLs and must be encoded.
  $_GET['q'] = request_path();

519
520
  // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  error_reporting(E_ALL | error_reporting());
521

522
523
524
  // 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.
525

526
  // Prevent PHP from generating HTML error messages.
527
  ini_set('html_errors', 0);
528
  // Don't escape quotes when reading files from the database, disk, etc.
529
  ini_set('magic_quotes_runtime', '0');
530
531
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
532
  ini_set('session.use_cookies', '1');
533
  ini_set('session.use_only_cookies', '1');
534
  ini_set('session.use_trans_sid', '0');
535
536
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
537
538
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
539
540
541
542

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

545
/**
546
 * Validate that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
547
548
549
550
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
551
552
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
553
554
}

555
/**
556
557
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
558
 */
559
function drupal_settings_initialize() {
560
561
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
562
  // Export the following settings.php variables to the global namespace
563
  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;
Dries's avatar
Dries committed
564
565
  $conf = array();

566
567
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
568
  }
569
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
570
571
572
573

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
574
    $http_protocol = $parts['scheme'];
575
576
577
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
578
    $base_path = $parts['path'] . '/';
579
580
581
582
583
    // 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
584
    $http_protocol = $is_https ? 'https' : 'http';
585
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
586

587
    $base_url = $base_root;
588
589
590

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
591
592
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
      $base_path = $dir;
593
594
595
596
597
598
599
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
600
601
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
602
603
604
605
606
607

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
608
609
610
    // 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);
611
612
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
613
    if (!empty($_SERVER['HTTP_HOST'])) {
614
      $cookie_domain = $_SERVER['HTTP_HOST'];
615
616
617
618
619
620
621
      // 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];
622
623
624
625
626
627
628
    }
  }
  // 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);
  }
629
630
631
632
633
634
635
636
637
638
  // 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';
639
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
640
641
}

Dries's avatar
Dries committed
642
643
/**
 * Returns and optionally sets the filename for a system item (module,
644
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
645
646
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
647
648
649
650
651
652
653
654
655
656
657
658
 * 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
659
 * @param $type
660
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
661
662
663
664
665
666
667
668
669
 * @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
670
function drupal_get_filename($type, $name, $filename = NULL) {
671
672
673
  // The location of files will not change during the request, so do not use
  // drupal_static().
  static $files = array();
Dries's avatar
Dries committed
674

675
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
676
677
678
    $files[$type] = array();
  }

679
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
680
681
    $files[$type][$name] = $filename;
  }
682
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
683
684
    // nothing
  }
Dries's avatar
Dries committed
685
  // Verify that we have an active database connection, before querying
686
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
687
688
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
689
  else {
690
    try {
691
692
693
694
695
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
        if (file_exists($file)) {
          $files[$type][$name] = $file;
        }
696
697
      }
    }
698
    catch (Exception $e) {
699
700
701
702
703
704
705
706
707
708
709
      // 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';
710
        $extension = 'engine';
711
712
      }
      elseif ($type == 'theme') {
713
        $extension = 'info';
714
715
      }
      else {
716
        $extension = $type;
717
718
      }

719
720
721
      if (!function_exists('drupal_system_listing')) {
        require_once DRUPAL_ROOT . '/includes/common.inc';
      }
722
723
724
725
726
727
728
      // 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("/\.$extension$/", $dir, 'name', 0);
      foreach ($matches as $matched_name => $file) {
        $files[$type][$matched_name] = $file->uri;
Dries's avatar
Dries committed
729
730
731
732
      }
    }
  }

733
734
735
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
736
737
}

Dries's avatar
   
Dries committed
738
739
740
741
742
743
744
/**
 * Load the persistent variable table.
 *
 * The variable table is composed of values that have been saved in the table
 * with variable_set() as well as those explicitly specified in the configuration
 * file.
 */
745
function variable_initialize($conf = array()) {
746
747
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
748
  if ($cached = cache_get('variables', 'cache_bootstrap')) {
749
    $variables = $cached->data;
Dries's avatar
   
Dries committed
750
751
  }
  else {
752
753
754
755
756
757
758
759
760
761
762
763
764
765
    // 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());
      cache_set('variables', $variables, 'cache_bootstrap');
      lock_release($name);
    }
Dries's avatar
   
Dries committed
766
767
768
769
  }

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

Dries's avatar
   
Dries committed
772
  return $variables;
Dries's avatar
   
Dries committed
773
774
}

Dries's avatar
   
Dries committed
775
/**
776
777
778
779
780
 * 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
781
782
783
784
785
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
786
 *
Dries's avatar
   
Dries committed
787
788
 * @return
 *   The value of the variable.
789
 *
790
791
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
792
 */
793
function variable_get($name, $default = NULL) {
Dries's avatar
   
Dries committed
794
795
796
797
798
  global $conf;

  return isset($conf[$name]) ? $conf[$name] : $default;
}

Dries's avatar
   
Dries committed
799
/**
800
801
802
803
804
 * Sets 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
805
806
807
808
809
810
 *
 * @param $name
 *   The name of the variable to set.
 * @param $value
 *   The value to set. This can be any PHP data type; these functions take care
 *   of serialization as necessary.
811
 *
812
813
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
814
 */
Dries's avatar
   
Dries committed
815
816
817
function variable_set($name, $value) {
  global $conf;

818
  db_merge('variable')->key(array('name' => $name))->fields(array('value' => serialize($value)))->execute();
Dries's avatar
   
Dries committed
819

820
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
   
Dries committed
821
822
823
824

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
825
/**
826
827
828
829
830
 * Unsets 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
831
832
833
 *
 * @param $name
 *   The name of the variable to undefine.
834
 *
835
836
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
837
 */
Dries's avatar
   
Dries committed
838
function variable_del($name) {
Dries's avatar
Dries committed
839
840
  global $conf;

841
842
843
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
844
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
   
Dries committed
845

Dries's avatar
Dries committed
846
  unset($conf[$name]);
Dries's avatar
   
Dries committed
847
848
}

Dries's avatar
   
Dries committed
849
850
851
/**
 * Retrieve the current page from the cache.
 *
852
853
854
855
856
 * 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.
 *
857
858
859
860
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
861
 * @return
862
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
863
 */
864
function drupal_page_get_cache($check_only = FALSE) {
865
  global $base_root;
866
867
868
869
870
  static $cache_hit = FALSE;

  if ($check_only) {
    return $cache_hit;
  }
Dries's avatar
   
Dries committed
871

872
  if (drupal_page_is_cacheable()) {
873
874
875
876
877
    $cache = cache_get($base_root . request_uri(), 'cache_page');
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
878
  }
879
880
881
882
883
884
}

/**
 * Determine the cacheability of the current page.
 *
 * @param $allow_caching
885
886
 *   Set to FALSE if you want to prevent this page to get cached.
 *
887
 * @return
888
 *   TRUE if the current page can be cached, FALSE otherwise.
889
890
891
892
893
 */
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
894
  }
895
896

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
897
    && !drupal_is_cli();
Dries's avatar
   
Dries committed
898
899
}

900
/**
901
 * Invoke a bootstrap hook in all bootstrap modules that implement it.
902
903
 *
 * @param $hook
904
 *   The name of the bootstrap hook to invoke.
905
906
 *
 * @see bootstrap_hooks()
907
908
 */
function bootstrap_invoke_all($hook) {
909
910
  // Bootstrap modules should have been loaded when this function is called, so
  // we don't need to tell module_list() to reset its bootstrap list.
911
  foreach (module_list(FALSE, TRUE) as $module) {
912
913
914
915
916
    drupal_load('module', $module);
    module_invoke($module, $hook);
  }
}

Dries's avatar
Dries committed
917
/**
918
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
919
920
921
922
923
924
925
926
927
928
929
 * including a theme, engine, module, etc., more than once.
 *
 * @param $type
 *   The type of item to load (i.e. theme, theme_engine, module).
 * @param $name
 *   The name of the item to load.
 *
 * @return
 *   TRUE if the item is loaded or has already been loaded.
 */
function drupal_load($type, $name) {
930
931
932
  // Once a file is included this can't be reversed during a request so do not
  // use drupal_static() here.
  static $files = array();
Dries's avatar
Dries committed
933

934
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
935
936
937
938
939
940
    return TRUE;
  }

  $filename = drupal_get_filename($type, $name);

  if ($filename) {
941
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
942
943
944
945
946
947
948
949
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

950
951
952
953
954
955
956
/**
 * Set an HTTP response header for the current page.
 *
 * 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
957
 *   The HTTP header name, or the special 'Status' header name.
958
 * @param $value
959
960
961
 *   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".
962
963
964
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
 */
965
function drupal_add_http_header($name, $value, $append = FALSE) {
966
  // The headers as name/value pairs.
967
  $headers = &drupal_static('drupal_http_headers', array());
968

969
  $name_lower = strtolower($name);
970
  _drupal_set_preferred_header_name($name);
971

972
  if ($value === FALSE) {
973
    $headers[$name_lower] = FALSE;
974
  }
975
  elseif (isset($headers[$name_lower]) && $append) {
976
977
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
978
    $headers[$name_lower] .= ',' . $value;
979
980
  }
  else {
981
    $headers[$name_lower] = $value;
982
  }
983
  drupal_send_headers(array($name => $headers[$name_lower]), TRUE);
984
985
986
987
988
989
990
991
992
993
994
995
}

/**
 * Get the HTTP response headers for the current page.
 *
 * @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.
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
 */
996
function drupal_get_http_header($name = NULL) {
997
  $headers = &drupal_static('drupal_http_headers', array());
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
 * Header names are case-insensitive, but for maximum compatibility they should
 * follow "common form" (see RFC 2617, section 4.2).
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

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

/**
1021
 * Send the HTTP response headers previously set using drupal_add_http_header().
1022
 * Add default headers, unless they have been replaced or unset using
1023
 * drupal_add_http_header().
1024
1025
1026
1027
1028
1029
1030
1031
 *
 * @param $default_headers
 *   An array of headers as name/value pairs.
 * @param $single
 *   If TRUE and headers have already be sent, send only the specified header.
 */
function drupal_send_headers($default_headers = array(), $only_default = FALSE) {
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
1032
  $headers = drupal_get_http_header();
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
  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) {
1047
    if ($name_lower == 'status') {
1048
1049
1050
1051
1052
1053
1054
1055
1056
      header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
    }
    // Skip headers that have been unset.
    elseif ($value) {
      header($header_names[$name_lower] . ': ' . $value);
    }
  }
}

Dries's avatar
   
Dries committed
1057
1058
/**
 * Set HTTP headers in preparation for a page response.
1059
 *
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 * 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.
 *
 * Also give each page a unique ETag. This will force clients to include both
 * 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.
1081
 *
1082
 * @see drupal_page_set_cache()
Dries's avatar
   
Dries committed
1083
 */
Dries's avatar
   
Dries committed
1084
function drupal_page_header() {
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
  $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',
    'Last-Modified' => gmdate(DATE_RFC1123, REQUEST_TIME),
    'Cache-Control' => 'no-cache, must-revalidate, post-check=0, pre-check=0',
    'ETag' => '"' . REQUEST_TIME . '"',
  );
  drupal_send_headers($default_headers);
1098
}
Dries's avatar
   
Dries committed
1099

1100
1101
1102
/**
 * Set HTTP headers in preparation for a cached page response.
 *
1103
1104
 * The headers allow as much as possible in proxies and browsers without any
 * particular knowledge about the pages. Modules can override these headers
1105
 * using drupal_add_http_header().
1106
 *
1107
1108
1109
1110
 * 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.
 */
1111
function drupal_serve_page_from_cache(stdClass $cache) {
1112
1113
1114
1115
1116
  // Negotiate whether to use compression.
  $page_compression = variable_get('page_compression', TRUE) && extension_loaded('zlib');
  $return_compressed = $page_compression && isset($_SERVER['HTTP_ACCEPT_ENCODING']) && strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== FALSE;

  // Get headers set in hook_boot(). Keys are lower-case.
1117
  $hook_boot_headers = drupal_get_http_header();
1118
1119

  // Headers generated in this function, that may be replaced or unset using
1120
  // drupal_add_http_headers(). Keys are mixed-case.
1121
1122
  $default_headers = array();

1123
  foreach ($cache->data['headers'] as $name => $value) {
1124
1125
1126
1127
1128
    // In the case of a 304 response, certain headers must be sent, and the
    // remaining may not (see RFC 2616, section 10.3.5). Do not override
    // headers set in hook_boot().
    $name_lower = strtolower($name);
    if (in_array($name_lower, array('content-location', 'expires', 'cache-control', 'vary')) && !isset($hook_boot_headers[$name_lower])) {
1129
      drupal_add_http_header($name, $value);
1130
      unset($cache->data['headers'][$name]);
1131
1132
1133
1134
1135
    }
  }

  // If a cache is served from a HTTP proxy without hitting the web server,
  // the boot and exit hooks cannot be fired, so only allow caching in
1136
1137
  // proxies if boot hooks are disabled. If the client send a session cookie,
  // do not bother caching the page in a public proxy, because the cached copy
1138
1139
  // will only be served to that particular user due to Vary: Cookie, unless
  // the Vary header has been replaced or unset in hook_boot() (see below).
1140
  $max_age = !variable_get('page_cache_invoke_hooks', TRUE) && (!isset($_COOKIE[session_name()]) || isset($hook_boot_headers['vary'])) ? variable_get('page_cache_maximum_age', 0) : 0;
1141
1142
1143
1144
1145
  $default_headers['Cache-Control'] = 'public, max-age=' . $max_age;

  // Entity tag should change if the output changes.
  $etag = '"' . $cache->created . '-' . intval($return_compressed) . '"';
  header('Etag: ' . $etag);
1146

1147
1148
  // See if the client has provided the required HTTP headers.
  $if_modified_since = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) : FALSE;
1149
1150
1151
1152
  $if_none_match = isset($_SERVER['HTTP_IF_NONE_MATCH']) ? stripslashes($_SERVER['HTTP_IF_NONE_MATCH']) : FALSE;

  if ($if_modified_since && $if_none_match
      && $if_none_match == $etag // etag must match
1153
      && $if_modified_since == $cache->created) {  // if-modified-since must match
1154
    header($_SERVER['SERVER_PROTOCOL'] . ' 304 Not Modified');
1155
    drupal_send_headers($default_headers);
1156
    return;
1157
  }
1158

1159
  // Send the remaining headers.
1160
  foreach ($cache->data['headers'] as $name => $value) {
1161
    drupal_add_http_header($name, $value);
1162
  }
1163

1164
  $default_headers['Last-Modified'] = gmdate(DATE_RFC1123, $cache->created);
1165

1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181