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

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

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

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

/**
 * Minimum supported version of PHP.
 */
define('DRUPAL_MINIMUM_PHP',    '5.2.0');

/**
 * 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 Buytaert's avatar
 
Dries Buytaert committed
50

51
52
53
/**
 * Indicates that page caching is disabled.
 */
54
define('CACHE_DISABLED', 0);
55
56
57
58

/**
 * Indicates that page caching is enabled, using "normal" mode.
 */
59
define('CACHE_NORMAL', 1);
60

61
/**
62
 * Log message severity -- Emergency: system is unusable.
63
 *
64
65
 * @see watchdog()
 * @see watchdog_severity_levels()
66
 */
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
define('WATCHDOG_EMERG', 0);

/**
 * Log message severity -- Alert: action must be taken immediately.
 *
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_ALERT', 1);

/**
 * Log message severity -- Critical: critical conditions.
 *
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_CRITICAL', 2);

/**
 * Log message severity -- Error: error conditions.
 *
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_ERROR', 3);

/**
 * Log message severity -- Warning: warning conditions.
 *
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_WARNING', 4);

/**
 * Log message severity -- Notice: normal but significant condition.
 *
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_NOTICE', 5);

/**
 * Log message severity -- Informational: informational messages.
 *
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_INFO', 6);

/**
 * Log message severity -- Debug: debug-level messages.
 *
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_DEBUG', 7);
124

125
126
127
/**
 * First bootstrap phase: initialize configuration.
 */
128
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
129
130

/**
131
 * Second bootstrap phase: try to serve a cached page.
132
 */
133
define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 1);
134
135
136
137

/**
 * Third bootstrap phase: initialize database layer.
 */
138
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
139
140

/**
141
 * Fourth bootstrap phase: initialize the variable system.
142
 */
143
define('DRUPAL_BOOTSTRAP_VARIABLES', 3);
144
145

/**
146
 * Fifth bootstrap phase: initialize session handling.
147
 */
148
define('DRUPAL_BOOTSTRAP_SESSION', 4);
149
150

/**
151
 * Sixth bootstrap phase: set up the page header.
152
 */
153
define('DRUPAL_BOOTSTRAP_PAGE_HEADER', 5);
154
155

/**
156
 * Seventh bootstrap phase: find out language of the page.
157
 */
158
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);
159
160
161
162
163

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

166
167
168
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
169
define('DRUPAL_ANONYMOUS_RID', 1);
170
171
172
173

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

176
/**
177
 * The number of bytes in a kilobyte. For more information, visit
178
179
180
181
 * http://en.wikipedia.org/wiki/Kilobyte.
 */
define('DRUPAL_KILOBYTE', 1024);

182
183
184
/**
 * The language code used when no language is explicitly assigned.
 *
185
 * Defined by ISO639-2 for "Undetermined".
186
 */
187
define('LANGUAGE_NONE', 'und');
188

189
/**
190
 * The type of language used to define the content language.
191
 */
192
define('LANGUAGE_TYPE_CONTENT', 'language_content');
193
194

/**
195
 * The type of language used to select the user interface.
196
 */
197
define('LANGUAGE_TYPE_INTERFACE', 'language');
198
199

/**
200
 * The type of language used for URLs.
201
 */
202
define('LANGUAGE_TYPE_URL', 'language_url');
203

204
205
206
207
208
209
210
211
212
213
/**
 * 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);

214
215
216
/**
 * For convenience, define a short form of the request time global.
 */
217
define('REQUEST_TIME', $_SERVER['REQUEST_TIME']);
218

219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/**
 * @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);

235
/**
236
 * Signals that the registry lookup cache should be reset.
237
238
239
240
 */
define('REGISTRY_RESET_LOOKUP_CACHE', 1);

/**
241
 * Signals that the registry lookup cache should be written to storage.
242
243
244
 */
define('REGISTRY_WRITE_LOOKUP_CACHE', 2);

245
246
247
248
249
/**
 * @} End of "Title text filtering flags".
 */


Dries Buytaert's avatar
   
Dries Buytaert committed
250
/**
251
252
 * Start the timer with the specified name. If you start and stop the same
 * timer multiple times, the measured intervals will be accumulated.
Dries Buytaert's avatar
   
Dries Buytaert committed
253
254
255
256
257
258
259
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

260
  $timers[$name]['start'] = microtime(TRUE);
261
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries Buytaert's avatar
   
Dries Buytaert committed
262
263
264
265
266
267
268
269
270
271
272
273
274
}

/**
 * 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;

275
  if (isset($timers[$name]['start'])) {
276
    $stop = microtime(TRUE);
277
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
278

279
280
281
282
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
283
  }
284
  return $timers[$name]['time'];
Dries Buytaert's avatar
   
Dries Buytaert committed
285
286
287
288
289
290
291
292
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
293
294
 *   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 Buytaert's avatar
   
Dries Buytaert committed
295
296
297
298
 */
function timer_stop($name) {
  global $timers;

299
300
301
302
303
304
305
306
307
308
  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']);
309
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
310
311
312

  return $timers[$name];
}
313

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

381
  if ($conf && !$reset) {
382
383
    return $conf;
  }
Dries Buytaert's avatar
 
Dries Buytaert committed
384

Dries Buytaert's avatar
   
Dries Buytaert committed
385
  $confdir = 'sites';
386
387
388
389
390
391
392

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

393
  $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
394
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
395
396
397
  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));
398
399
400
401
      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))) {
402
403
404
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries Buytaert's avatar
 
Dries Buytaert committed
405
406
    }
  }
407
408
  $conf = "$confdir/default";
  return $conf;
Dries Buytaert's avatar
 
Dries Buytaert committed
409
410
}

411
412
413
414
415
416
417
418
419
420
421
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
/**
 * 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,
464
    'SERVER_SOFTWARE' => NULL,
465
466
467
468
469
470
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

471
/**
472
 * Initialize PHP environment.
473
 */
474
function drupal_environment_initialize() {
475
476
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
477
  }
478
479
480
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
481

482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
  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'] = '';
497
498
  }

499
500
501
502
503
504
505
  // 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();

506
507
  // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  error_reporting(E_ALL | error_reporting());
508

509
510
511
  // 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.
512

513
  // Prevent PHP from generating HTML error messages.
514
  ini_set('html_errors', 0);
515
  // Don't escape quotes when reading files from the database, disk, etc.
516
  ini_set('magic_quotes_runtime', '0');
517
518
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
519
  ini_set('session.use_cookies', '1');
520
  ini_set('session.use_only_cookies', '1');
521
  ini_set('session.use_trans_sid', '0');
522
523
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
524
525
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
526
527
528
529

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

532
/**
533
 * Validate that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
534
535
536
537
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
538
539
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
540
541
}

542
/**
543
544
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
545
 */
546
function drupal_settings_initialize() {
547
548
  global $base_url, $base_path, $base_root;

Dries Buytaert's avatar
Dries Buytaert committed
549
  // Export the following settings.php variables to the global namespace
550
  global $databases, $db_prefix, $cookie_domain, $conf, $installed_profile, $update_free_access, $db_url, $drupal_hash_salt, $is_https, $base_secure_url, $base_insecure_url;
Dries Buytaert's avatar
Dries Buytaert committed
551
552
  $conf = array();

553
554
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
555
  }
556
557
558
559

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
560
    $http_protocol = $parts['scheme'];
561
562
563
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
564
    $base_path = $parts['path'] . '/';
565
566
567
568
569
    // 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
570
571
    $http_protocol = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
572

573
    $base_url = $base_root;
574
575
576

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
577
578
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
      $base_path = $dir;
579
580
581
582
583
584
585
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
586
587
588
  $is_https = $http_protocol == 'https';
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
589
590
591
592
593
594

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
595
596
597
    // 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);
598
599
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
600
    if (!empty($_SERVER['HTTP_HOST'])) {
601
      $cookie_domain = $_SERVER['HTTP_HOST'];
602
603
604
605
606
607
608
    }
  }
  // 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);
  }
609
  $cookie_domain = explode(':', $cookie_domain);
610
  $cookie_domain = '.' . $cookie_domain[0];
611
612
613
614
615
  // 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);
  }
616
617
618
619
620
621
622
623
624
625
626
  // 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';
  session_name($prefix . md5($session_name));
627
628
}

Dries Buytaert's avatar
Dries Buytaert committed
629
630
/**
 * Returns and optionally sets the filename for a system item (module,
631
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries Buytaert's avatar
Dries Buytaert committed
632
633
 * from the database, is only returned if the file exists.
 *
Dries Buytaert's avatar
Dries Buytaert committed
634
635
636
637
638
639
640
641
642
643
644
645
 * 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 Buytaert's avatar
Dries Buytaert committed
646
 * @param $type
647
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries Buytaert's avatar
Dries Buytaert committed
648
649
650
651
652
653
654
655
656
 * @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 Buytaert's avatar
Dries Buytaert committed
657
function drupal_get_filename($type, $name, $filename = NULL) {
658
659
660
  // The location of files will not change during the request, so do not use
  // drupal_static().
  static $files = array();
Dries Buytaert's avatar
Dries Buytaert committed
661

662
  if (!isset($files[$type])) {
Dries Buytaert's avatar
Dries Buytaert committed
663
664
665
    $files[$type] = array();
  }

666
  if (!empty($filename) && file_exists($filename)) {
Dries Buytaert's avatar
Dries Buytaert committed
667
668
    $files[$type][$name] = $filename;
  }
669
  elseif (isset($files[$type][$name])) {
Dries Buytaert's avatar
Dries Buytaert committed
670
671
    // nothing
  }
Dries Buytaert's avatar
Dries Buytaert committed
672
  // Verify that we have an active database connection, before querying
673
  // the database. This is required because this function is called both
Dries Buytaert's avatar
Dries Buytaert committed
674
675
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries Buytaert's avatar
Dries Buytaert committed
676
  else {
677
    try {
678
679
680
681
682
      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;
        }
683
684
      }
    }
685
    catch (Exception $e) {
686
687
688
689
690
691
692
693
694
695
696
      // 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';
697
        $extension = 'engine';
698
699
      }
      elseif ($type == 'theme') {
700
        $extension = 'info';
701
702
      }
      else {
703
        $extension = $type;
704
705
      }

706
707
708
      if (!function_exists('drupal_system_listing')) {
        require_once DRUPAL_ROOT . '/includes/common.inc';
      }
709
710
711
712
713
714
715
      // 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 Buytaert's avatar
Dries Buytaert committed
716
717
718
719
      }
    }
  }

720
721
722
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries Buytaert's avatar
Dries Buytaert committed
723
724
}

Dries Buytaert's avatar
   
Dries Buytaert committed
725
726
727
728
729
730
731
/**
 * 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.
 */
732
function variable_initialize($conf = array()) {
733
  // NOTE: caching the variables improves performance by 20% when serving cached pages.
734
  if ($cached = cache_get('variables', 'cache_bootstrap')) {
735
    $variables = $cached->data;
Dries Buytaert's avatar
   
Dries Buytaert committed
736
737
  }
  else {
738
    $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
739
    cache_set('variables', $variables, 'cache_bootstrap');
Dries Buytaert's avatar
   
Dries Buytaert committed
740
741
742
743
  }

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

Dries Buytaert's avatar
   
Dries Buytaert committed
746
  return $variables;
Dries Buytaert's avatar
 
Dries Buytaert committed
747
748
}

Dries Buytaert's avatar
   
Dries Buytaert committed
749
750
751
752
753
754
755
756
757
/**
 * Return a persistent variable.
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
 * @return
 *   The value of the variable.
758
759
 *
 * @see variable_del(), variable_set()
Dries Buytaert's avatar
   
Dries Buytaert committed
760
 */
761
function variable_get($name, $default = NULL) {
Dries Buytaert's avatar
 
Dries Buytaert committed
762
763
764
765
766
  global $conf;

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

Dries Buytaert's avatar
   
Dries Buytaert committed
767
768
769
770
771
772
773
774
/**
 * Set a persistent variable.
 *
 * @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.
775
776
 *
 * @see variable_del(), variable_get()
Dries Buytaert's avatar
   
Dries Buytaert committed
777
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
778
779
780
function variable_set($name, $value) {
  global $conf;

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

783
  cache_clear_all('variables', 'cache_bootstrap');
Dries Buytaert's avatar
 
Dries Buytaert committed
784
785
786
787

  $conf[$name] = $value;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
788
789
790
791
792
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
793
794
 *
 * @see variable_get(), variable_set()
Dries Buytaert's avatar
   
Dries Buytaert committed
795
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
796
function variable_del($name) {
Dries Buytaert's avatar
Dries Buytaert committed
797
798
  global $conf;

799
800
801
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
802
  cache_clear_all('variables', 'cache_bootstrap');
Dries Buytaert's avatar
 
Dries Buytaert committed
803

Dries Buytaert's avatar
Dries Buytaert committed
804
  unset($conf[$name]);
Dries Buytaert's avatar
 
Dries Buytaert committed
805
806
}

Dries Buytaert's avatar
   
Dries Buytaert committed
807
808
809
/**
 * Retrieve the current page from the cache.
 *
810
811
812
813
814
 * 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.
 *
815
816
817
818
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
819
 * @return
820
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries Buytaert's avatar
   
Dries Buytaert committed
821
 */
822
function drupal_page_get_cache($check_only = FALSE) {
823
  global $base_root;
824
825
826
827
828
  static $cache_hit = FALSE;

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

830
  if (drupal_page_is_cacheable()) {
831
832
833
834
835
    $cache = cache_get($base_root . request_uri(), 'cache_page');
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
836
  }
837
838
839
840
841
842
}

/**
 * Determine the cacheability of the current page.
 *
 * @param $allow_caching
843
844
 *   Set to FALSE if you want to prevent this page to get cached.
 *
845
 * @return
846
 *   TRUE if the current page can be cached, FALSE otherwise.
847
848
849
850
851
 */
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 Buytaert's avatar
 
Dries Buytaert committed
852
  }
853
854

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
855
    && !drupal_is_cli();
Dries Buytaert's avatar
 
Dries Buytaert committed
856
857
}

858
859
860
861
862
863
864
/**
 * Call all init or exit hooks without including all modules.
 *
 * @param $hook
 *   The name of the bootstrap hook we wish to invoke.
 */
function bootstrap_invoke_all($hook) {
865
866
867
  // _drupal_bootstrap_page_cache() already loaded the bootstrap modules, so we
  // don't need to tell module_list() to reset its bootstrap list.
  foreach (module_list(FALSE, TRUE) as $module) {
868
869
870
871
872
    drupal_load('module', $module);
    module_invoke($module, $hook);
  }
}

Dries Buytaert's avatar
Dries Buytaert committed
873
/**
874
 * Includes a file with the provided type and name. This prevents
Dries Buytaert's avatar
Dries Buytaert committed
875
876
877
878
879
880
881
882
883
884
885
 * 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) {
886
887
888
  // Once a file is included this can't be reversed during a request so do not
  // use drupal_static() here.
  static $files = array();
Dries Buytaert's avatar
Dries Buytaert committed
889

890
  if (isset($files[$type][$name])) {
Dries Buytaert's avatar
Dries Buytaert committed
891
892
893
894
895
896
    return TRUE;
  }

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

  if ($filename) {
897
    include_once DRUPAL_ROOT . '/' . $filename;
Dries Buytaert's avatar
Dries Buytaert committed
898
899
900
901
902
903
904
905
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

906
907
908
909
910
911
912
/**
 * 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
913
 *   The HTTP header name, or the special 'Status' header name.
914
 * @param $value
915
916
917
 *   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".
918
919
920
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
 */
921
function drupal_add_http_header($name, $value, $append = FALSE) {
922
  // The headers as name/value pairs.
923
  $headers = &drupal_static('drupal_http_headers', array());
924

925
  $name_lower = strtolower($name);
926
  _drupal_set_preferred_header_name($name);
927

928
  if ($value === FALSE) {
929
    $headers[$name_lower] = FALSE;
930
  }
931
  elseif (isset($headers[$name_lower]) && $append) {
932
933
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
934
    $headers[$name_lower] .= ',' . $value;
935
936
  }
  else {
937
    $headers[$name_lower] = $value;
938
  }
939
  drupal_send_headers(array($name => $headers[$name_lower]), TRUE);
940
941
942
943
944
945
946
947
948
949
950
951
}

/**
 * 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.
 */
952
function drupal_get_http_header($name = NULL) {
953
  $headers = &drupal_static('drupal_http_headers', array());
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
  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;
}

/**
977
 * Send the HTTP response headers previously set using drupal_add_http_header().
978
 * Add default headers, unless they have been replaced or unset using
979
 * drupal_add_http_header().
980
981
982
983
984
985
986
987
 *
 * @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);
988
  $headers = drupal_get_http_header();
989
990
991
992
993
994
995
996
997
998
999
1000
  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;
    }
For faster browsing, not all history is shown. View entire blame