bootstrap.inc 47.2 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
12
/**
 * Indicates that the item should never be removed unless explicitly told to
 * using cache_clear_all() with a cache ID.
 */
13
define('CACHE_PERMANENT', 0);
14
15
16
17

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

20
21
22
/**
 * Indicates that page caching is disabled.
 */
23
define('CACHE_DISABLED', 0);
24
25
26
27

/**
 * Indicates that page caching is enabled, using "normal" mode.
 */
28
define('CACHE_NORMAL', 1);
29
30
31
32
33
34

/**
 * Indicates that page caching is using "aggressive" mode. This bypasses
 * loading any modules for additional speed, which may break functionality in
 * modules that expect to be run on each page load.
 */
35
define('CACHE_AGGRESSIVE', 2);
36

37
/**
38
 * Log message severity -- Emergency: system is unusable.
39
 *
40
41
 * @see watchdog()
 * @see watchdog_severity_levels()
42
 */
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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
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);
100

101
102
103
/**
 * First bootstrap phase: initialize configuration.
 */
104
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
105
106
107
108
109

/**
 * Second bootstrap phase: try to call a non-database cache
 * fetch routine.
 */
110
define('DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE', 1);
111
112
113
114

/**
 * Third bootstrap phase: initialize database layer.
 */
115
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
116
117
118
119

/**
 * Fourth bootstrap phase: identify and reject banned hosts.
 */
120
define('DRUPAL_BOOTSTRAP_ACCESS', 3);
121
122
123
124

/**
 * Fifth bootstrap phase: initialize session handling.
 */
125
define('DRUPAL_BOOTSTRAP_SESSION', 4);
126
127
128
129
130

/**
 * Sixth bootstrap phase: load bootstrap.inc and module.inc, start
 * the variable system and try to serve a page from the cache.
 */
131
define('DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE', 5);
132
133

/**
134
 * Seventh bootstrap phase: find out language of the page.
135
 */
136
137
138
139
140
141
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);

/**
 * Eighth bootstrap phase: set $_GET['q'] to Drupal path of request.
 */
define('DRUPAL_BOOTSTRAP_PATH', 7);
142
143
144
145
146

/**
 * Final bootstrap phase: Drupal is fully loaded; validate and fix
 * input data.
 */
147
define('DRUPAL_BOOTSTRAP_FULL', 8);
148

149
150
151
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
152
define('DRUPAL_ANONYMOUS_RID', 1);
153
154
155
156

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

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/**
 * No language negotiation. The default language is used.
 */
define('LANGUAGE_NEGOTIATION_NONE', 0);

/**
 * Path based negotiation with fallback to default language
 * if no defined path prefix identified.
 */
define('LANGUAGE_NEGOTIATION_PATH_DEFAULT', 1);

/**
 * Path based negotiation with fallback to user preferences
 * and browser language detection if no defined path prefix
 * identified.
 */
define('LANGUAGE_NEGOTIATION_PATH', 2);

/**
 * Domain based negotiation with fallback to default language
 * if no language identified by domain.
 */
define('LANGUAGE_NEGOTIATION_DOMAIN', 3);

183
184
185
/**
 * For convenience, define a short form of the request time global.
 */
186
define('REQUEST_TIME', $_SERVER['REQUEST_TIME']);
187

188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/**
 * @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);

/**
 * @} End of "Title text filtering flags".
 */


Dries's avatar
   
Dries committed
209
/**
210
 * Start the timer with the specified name. If you start and stop
Dries's avatar
   
Dries committed
211
212
213
214
215
216
217
218
219
220
221
 * the same timer multiple times, the measured intervals will be
 * accumulated.
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

  list($usec, $sec) = explode(' ', microtime());
  $timers[$name]['start'] = (float)$usec + (float)$sec;
222
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
223
224
225
226
227
228
229
230
231
232
233
234
235
}

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

236
237
238
239
  if (isset($timers[$name]['start'])) {
    list($usec, $sec) = explode(' ', microtime());
    $stop = (float)$usec + (float)$sec;
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
240

241
242
243
244
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
245
  }
Dries's avatar
   
Dries committed
246
247
248
249
250
251
252
253
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
254
 *   A timer array. The array contains the number of times the
Dries's avatar
   
Dries committed
255
256
257
258
259
260
 *   timer has been started and stopped (count) and the accumulated
 *   timer value in ms (time).
 */
function timer_stop($name) {
  global $timers;

261
  $timers[$name]['time'] = timer_read($name);
Dries's avatar
   
Dries committed
262
263
264
265
  unset($timers[$name]['start']);

  return $timers[$name];
}
266

Dries's avatar
   
Dries committed
267
/**
268
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
269
 *
270
271
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
272
 * configuration file found will be used; the remaining will ignored. If no
273
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
274
 *
275
 * Example for a fictitious site installed at
276
277
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
278
 *
279
280
281
282
 *  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
283
 *
284
285
286
287
 *  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
288
 *
289
290
291
292
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
293
 *
294
 * 13. $confdir/default
295
 *
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 * If a file named sites.php is present in the $confdir, it will be loaded
 * prior to scanning for directories.  It should define an associative array
 * named $sites, which maps domains to directories.  It should be in the form
 * 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
 * domain of the live server.  Since Drupal stores file paths into the database
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
320
321
322
323
324
325
326
327
328
329
 * @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
330
 */
331
function conf_path($require_settings = TRUE, $reset = FALSE) {
Dries's avatar
Dries committed
332
  static $conf = '';
Dries's avatar
 
Dries committed
333

334
  if ($conf && !$reset) {
Dries's avatar
Dries committed
335
336
    return $conf;
  }
Dries's avatar
 
Dries committed
337

Dries's avatar
   
Dries committed
338
  $confdir = 'sites';
339
340
341
342
343
344
345

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

346
  $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
347
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
348
349
350
  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));
351
352
353
354
      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
355
356
357
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
358
359
    }
  }
Dries's avatar
Dries committed
360
361
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
362
363
}

364
/**
365
366
367
368
369
 * Initialize variables needed for the rest of the execution.
 */
function drupal_initialize_variables() {
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
370
  }
371
372
373
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
374
375
376
377
  // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  error_reporting(E_ALL | error_reporting());
  // Prevent PHP from generating HTML errors messages.
  ini_set('html_errors', 0);
378
379
}

380
/**
381
382
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
383
384
 */
function conf_init() {
385
386
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
387
  // Export the following settings.php variables to the global namespace
388
  global $databases, $db_prefix, $cookie_domain, $conf, $installed_profile, $update_free_access;
Dries's avatar
Dries committed
389
390
  $conf = array();

391
392
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
393
  }
394
395
396
397

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
398
399
400
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
401
    $base_path = $parts['path'] . '/';
402
403
404
405
406
407
    // 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
    $base_root = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
408
409
410

    // As $_SERVER['HTTP_HOST'] is user input, ensure it only contains
    // characters allowed in hostnames.
411
    $base_url = $base_root .= '://' . preg_replace('/[^a-z0-9-:._]/i', '', $_SERVER['HTTP_HOST']);
412
413
414
415

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
    if ($dir = trim(dirname($_SERVER['SCRIPT_NAME']), '\,/')) {
416
417
418
419
420
421
422
423
      $base_path = "/$dir";
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
424
425
426
427
428
429

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
430
431
432
    // 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);
433
    // We escape the hostname because it can be modified by a visitor.
434
    if (!empty($_SERVER['HTTP_HOST'])) {
435
      $cookie_domain = check_plain($_SERVER['HTTP_HOST']);
436
437
    }
  }
438
439
440
441
442
443
444
445
446
  // 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 (ini_get('session.cookie_secure')) {
    $session_name .= 'SSL';
  }
447
448
449
450
451
  // 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);
  }
452
  $cookie_domain = explode(':', $cookie_domain);
453
  $cookie_domain = '.' . $cookie_domain[0];
454
455
456
457
458
  // 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);
  }
459
  session_name('SESS' . md5($session_name));
460
461
}

Dries's avatar
Dries committed
462
463
/**
 * Returns and optionally sets the filename for a system item (module,
464
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
465
466
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
467
468
469
470
471
472
473
474
475
476
477
478
 * 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
479
480
481
482
483
484
485
486
487
488
489
 * @param $type
 *   The type of the item (i.e. theme, theme_engine, module).
 * @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
490
function drupal_get_filename($type, $name, $filename = NULL) {
Dries's avatar
Dries committed
491
492
  static $files = array();

493
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
494
495
496
    $files[$type] = array();
  }

497
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
498
499
    $files[$type][$name] = $filename;
  }
500
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
501
502
    // nothing
  }
Dries's avatar
Dries committed
503
504
505
506
  // Verify that we have an active database connection, before querying
  // the database.  This is required because this function is called both
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
507
  elseif (db_is_active() && (($file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField()) && file_exists($file))) {
Dries's avatar
Dries committed
508
509
510
    $files[$type][$name] = $file;
  }
  else {
Dries's avatar
Dries committed
511
512
    // Fallback to searching the filesystem if the database connection is
    // not established or the requested file is not found.
Steven Wittens's avatar
Steven Wittens committed
513
    $config = conf_path();
Dries's avatar
Dries committed
514
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
515
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
516
517
518
519
520
521
522
523
524

    foreach (array("$config/$dir/$file", "$config/$dir/$name/$file", "$dir/$file", "$dir/$name/$file") as $file) {
      if (file_exists($file)) {
        $files[$type][$name] = $file;
        break;
      }
    }
  }

525
526
527
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
528
529
}

Dries's avatar
   
Dries committed
530
531
532
533
534
535
536
/**
 * 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.
 */
Dries's avatar
 
Dries committed
537
function variable_init($conf = array()) {
538
  // NOTE: caching the variables improves performance by 20% when serving cached pages.
539
  if ($cached = cache_get('variables', 'cache')) {
540
    $variables = $cached->data;
Dries's avatar
   
Dries committed
541
542
  }
  else {
543
    $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
544
    cache_set('variables', $variables);
Dries's avatar
   
Dries committed
545
546
547
548
  }

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

Dries's avatar
   
Dries committed
551
  return $variables;
Dries's avatar
 
Dries committed
552
553
}

Dries's avatar
   
Dries committed
554
555
556
557
558
559
560
561
562
563
/**
 * 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.
 */
Dries's avatar
 
Dries committed
564
565
566
567
568
569
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
570
571
572
573
574
575
576
577
578
/**
 * 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.
 */
Dries's avatar
 
Dries committed
579
580
581
function variable_set($name, $value) {
  global $conf;

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

584
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
585
586
587
588

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
589
590
591
592
593
594
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
595
596
597
function variable_del($name) {
  global $conf;

598
599
600
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
601
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
602
603
604
605

  unset($conf[$name]);
}

606

Dries's avatar
   
Dries committed
607
608
609
/**
 * Retrieve the current page from the cache.
 *
610
 * Note: we do not serve cached pages when status messages are waiting (from
Dries's avatar
   
Dries committed
611
612
 * a redirected form submission which was completed).
 */
Dries's avatar
 
Dries committed
613
function page_get_cache() {
614
  global $user, $base_root;
Dries's avatar
 
Dries committed
615
616

  $cache = NULL;
617

618
  if (!$user->uid && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD') && count(drupal_set_message()) == 0) {
619
    $cache = cache_get($base_root . request_uri(), 'cache_page');
Dries's avatar
 
Dries committed
620
621
622
623
624
625
626
627
628

    if (empty($cache)) {
      ob_start();
    }
  }

  return $cache;
}

Dries's avatar
Dries committed
629
630
631
/**
 * Call all init or exit hooks without including all modules.
 *
632
 * @param $hook
Dries's avatar
Dries committed
633
634
 *   The name of the bootstrap hook we wish to invoke.
 */
635
function bootstrap_invoke_all($hook) {
636
  foreach (module_list(TRUE, TRUE) as $module) {
637
    module_invoke($module, $hook);
638
  }
Dries's avatar
Dries committed
639
640
641
}

/**
642
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
643
644
645
646
647
648
649
650
651
652
653
654
655
 * 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) {
  static $files = array();

656
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
657
658
659
660
661
662
    return TRUE;
  }

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

  if ($filename) {
663
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
664
665
666
667
668
669
670
671
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

Dries's avatar
   
Dries committed
672
673
/**
 * Set HTTP headers in preparation for a page response.
674
 *
675
676
677
678
 * Authenticated users are always given a 'no-cache' header, and will
 * fetch a fresh page on every request.  This prevents authenticated
 * users seeing locally cached pages that show them as logged out.
 *
679
 * @see page_set_cache()
Dries's avatar
   
Dries committed
680
 */
Dries's avatar
 
Dries committed
681
function drupal_page_header() {
682
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
683
  header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
684
  header("Cache-Control: store, no-cache, must-revalidate");
685
686
  header("Cache-Control: post-check=0, pre-check=0", FALSE);
}
Dries's avatar
   
Dries committed
687

688
689
690
691
692
693
694
695
696
697
698
/**
 * Set HTTP headers in preparation for a cached page response.
 *
 * The general approach here is that anonymous users can keep a local
 * cache of the page, but must revalidate it on every request.  Then,
 * they are given a '304 Not Modified' response as long as they stay
 * logged out and the page has not been modified.
 *
 */
function drupal_page_cache_header($cache) {
  // Set default values:
699
700
  $last_modified = gmdate('D, d M Y H:i:s', $cache->created) . ' GMT';
  $etag = '"' . md5($last_modified) . '"';
701
702
703
704
705
706
707
708

  // See if the client has provided the required HTTP headers:
  $if_modified_since = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? stripslashes($_SERVER['HTTP_IF_MODIFIED_SINCE']) : FALSE;
  $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
      && $if_modified_since == $last_modified) {  // if-modified-since must match
709
    header($_SERVER['SERVER_PROTOCOL'] . ' 304 Not Modified');
710
711
    // All 304 responses must send an etag if the 200 response for the same object contained an etag
    header("Etag: $etag");
712
    return;
713
  }
714

715
716
717
  // Send appropriate response:
  header("Last-Modified: $last_modified");
  header("ETag: $etag");
718

719
720
721
  // The following headers force validation of cache:
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
  header("Cache-Control: must-revalidate");
722

723
724
725
726
727
728
729
730
731
  if (variable_get('page_compression', TRUE)) {
    // Determine if the browser accepts gzipped data.
    if (@strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') === FALSE && function_exists('gzencode')) {
      // Strip the gzip header and run uncompress.
      $cache->data = gzinflate(substr(substr($cache->data, 10), 0, -8));
    }
    elseif (function_exists('gzencode')) {
      header('Content-Encoding: gzip');
    }
Dries's avatar
 
Dries committed
732
  }
733
734
735
736
737
738
739
740
741
742

  // Send the original request's headers. We send them one after
  // another so PHP's header() function can deal with duplicate
  // headers.
  $headers = explode("\n", $cache->headers);
  foreach ($headers as $header) {
    header($header);
  }

  print $cache->data;
Dries's avatar
 
Dries committed
743
744
}

Dries's avatar
   
Dries committed
745
746
747
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
748
function bootstrap_hooks() {
749
  return array('boot', 'exit');
Dries's avatar
 
Dries committed
750
751
}

Dries's avatar
   
Dries committed
752
753
754
755
756
757
758
759
/**
 * Unserializes and appends elements from a serialized string.
 *
 * @param $obj
 *   The object to which the elements are appended.
 * @param $field
 *   The attribute of $obj whose value should be unserialized.
 */
Dries's avatar
   
Dries committed
760
761
762
763
764
765
766
767
768
769
770
function drupal_unpack($obj, $field = 'data') {
  if ($obj->$field && $data = unserialize($obj->$field)) {
    foreach ($data as $key => $value) {
      if (!isset($obj->$key)) {
        $obj->$key = $value;
      }
    }
  }
  return $obj;
}

Dries's avatar
Dries committed
771
772
/**
 * Encode special characters in a plain-text string for display as HTML.
Gábor Hojtsy's avatar
Gábor Hojtsy committed
773
774
775
 *
 * Uses drupal_validate_utf8 to prevent cross site scripting attacks on
 * Internet Explorer 6.
Dries's avatar
Dries committed
776
777
 */
function check_plain($text) {
Gábor Hojtsy's avatar
Gábor Hojtsy committed
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
  return drupal_validate_utf8($text) ? htmlspecialchars($text, ENT_QUOTES) : '';
}

/**
 * Checks whether a string is valid UTF-8.
 *
 * All functions designed to filter input should use drupal_validate_utf8
 * to ensure they operate on valid UTF-8 strings to prevent bypass of the
 * filter.
 *
 * When text containing an invalid UTF-8 lead byte (0xC0 - 0xFF) is presented
 * as UTF-8 to Internet Explorer 6, the program may misinterpret subsequent
 * bytes. When these subsequent bytes are HTML control characters such as
 * quotes or angle brackets, parts of the text that were deemed safe by filters
 * end up in locations that are potentially unsafe; An onerror attribute that
 * is outside of a tag, and thus deemed safe by a filter, can be interpreted
 * by the browser as if it were inside the tag.
 *
 * This function exploits preg_match behaviour (since PHP 4.3.5) when used
 * with the u modifier, as a fast way to find invalid UTF-8. When the matched
 * string contains an invalid byte sequence, it will fail silently.
 *
 * preg_match may not fail on 4 and 5 octet sequences, even though they
 * are not supported by the specification.
 *
 * The specific preg_match behaviour is present since PHP 4.3.5.
 *
 * @param $text
 *   The text to check.
 * @return
 *   TRUE if the text is valid UTF-8, FALSE if not.
 */
function drupal_validate_utf8($text) {
  if (strlen($text) == 0) {
    return TRUE;
  }
  return (preg_match('/^./us', $text) == 1);
Dries's avatar
Dries committed
815
816
}

Dries's avatar
   
Dries committed
817
/**
818
819
 * Since $_SERVER['REQUEST_URI'] is only available on Apache, we
 * generate an equivalent using other environment variables.
Dries's avatar
   
Dries committed
820
 */
Dries's avatar
 
Dries committed
821
function request_uri() {
822
823
824
825
826
827

  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
    if (isset($_SERVER['argv'])) {
828
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
829
    }
830
    elseif (isset($_SERVER['QUERY_STRING'])) {
831
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
832
    }
833
834
835
    else {
      $uri = $_SERVER['SCRIPT_NAME'];
    }
Dries's avatar
 
Dries committed
836
  }
837

838
  return $uri;
Dries's avatar
 
Dries committed
839
}
Dries's avatar
Dries committed
840

Dries's avatar
   
Dries committed
841
842
843
844
845
846
/**
 * Log a system message.
 *
 * @param $type
 *   The category to which this message belongs.
 * @param $message
847
848
 *   The message to store in the log. See t() for documentation
 *   on how $message and $variables interact. Keep $message
849
 *   translatable by not concatenating dynamic values into it!
850
851
852
853
 * @param $variables
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
854
 * @param $severity
855
 *   The severity of the message, as per RFC 3164
Dries's avatar
   
Dries committed
856
857
 * @param $link
 *   A link to associate with the message.
858
 *
859
 * @see watchdog_severity_levels()
Dries's avatar
   
Dries committed
860
 */
861
function watchdog($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
862
  global $user, $base_root;
863

864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
  static $in_error_state = FALSE;

  // It is possible that the error handling will itself trigger an error.  In that case, we could
  // end up in an infinite loop.  To avoid that, we implement a simple static semaphore.
  if (!$in_error_state) {
    $in_error_state = TRUE;

    // Prepare the fields to be logged
    $log_message = array(
      'type'        => $type,
      'message'     => $message,
      'variables'   => $variables,
      'severity'    => $severity,
      'link'        => $link,
      'user'        => $user,
      'request_uri' => $base_root . request_uri(),
880
      'referer'     => $_SERVER['HTTP_REFERER'],
881
      'ip'          => ip_address(),
882
      'timestamp'   => REQUEST_TIME,
883
884
    );

885
886
887
888
    // Call the logging hooks to log/process the message
    foreach (module_implements('watchdog', TRUE) as $module) {
      module_invoke($module, 'watchdog', $log_message);
    }
889
  }
890
  $in_error_state = FALSE;
Dries's avatar
   
Dries committed
891
892
}

Dries's avatar
   
Dries committed
893
/**
894
 * Set a message which reflects the status of the performed operation.
Dries's avatar
   
Dries committed
895
 *
896
897
 * If the function is called with no arguments, this function returns all set
 * messages without clearing them.
Dries's avatar
   
Dries committed
898
 *
899
900
901
902
903
904
 * @param $message
 *   The message should begin with a capital letter and always ends with a
 *   period '.'.
 * @param $type
 *   The type of the message. One of the following values are possible:
 *   - 'status'
905
 *   - 'warning'
906
 *   - 'error'
907
908
909
 * @param $repeat
 *   If this is FALSE and the message is already set, then the message won't
 *   be repeated.
Dries's avatar
   
Dries committed
910
 */
911
function drupal_set_message($message = NULL, $type = 'status', $repeat = TRUE) {
912
  if ($message) {
Dries's avatar
   
Dries committed
913
914
915
916
917
918
919
920
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

    if (!isset($_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type] = array();
    }

921
922
923
    if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type][] = $message;
    }
924
925
  }

926
927
  // messages not set when DB connection fails
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
928
929
}

Dries's avatar
   
Dries committed
930
931
932
/**
 * Return all messages that have been set.
 *
933
934
 * @param $type
 *   (optional) Only return messages of this type.
935
936
 * @param $clear_queue
 *   (optional) Set to FALSE if you do not want to clear the messages queue
937
938
939
940
941
 * @return
 *   An associative array, the key is the message type, the value an array
 *   of messages. If the $type parameter is passed, you get only that type,
 *   or an empty array if there are no such messages. If $type is not passed,
 *   all message types are returned, or an empty array if none exist.
Dries's avatar
   
Dries committed
942
 */
943
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
944
  if ($messages = drupal_set_message()) {
945
    if ($type) {
946
      if ($clear_queue) {
947
        unset($_SESSION['messages'][$type]);
948
      }
949
950
951
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
952
953
    }
    else {
954
      if ($clear_queue) {
955
        unset($_SESSION['messages']);
956
      }
957
958
      return $messages;
    }
959
  }
960
  return array();
961
962
}

Dries's avatar
   
Dries committed
963
/**
964
965
966
967
968
969
970
971
972
 * Check to see if an IP address has been blocked.
 *
 * Blocked IP addresses are stored in the database by default. However for
 * performance reasons we allow an override in settings.php. This allows us
 * to avoid querying the database at this critical stage of the bootstrap if
 * an administrative interface for IP address blocking is not required.
 *
 * @param $ip string
 *   IP address to check.
973
974
 * @return bool
 *   TRUE if access is denied, FALSE if access is allowed.
Dries's avatar
   
Dries committed
975
 */
976
977
978
979
980
981
982
983
984
function drupal_is_denied($ip) {
  // Because this function is called on every page request, we first check
  // for an array of IP addresses in settings.php before querying the
  // database.
  $blocked_ips = variable_get('blocked_ips', NULL);
  if (isset($blocked_ips) && is_array($blocked_ips)) {
    return in_array($ip, $blocked_ips);
  }
  else {
985
    return (bool)db_query("SELECT 1 FROM {blocked_ips} WHERE ip = :ip", array(':ip' => $ip))->fetchField();
986
  }
Dries's avatar
   
Dries committed
987
988
}

989
/**
990
 * Generates a default anonymous $user object.
991
992
993
 *
 * @return Object - the user object.
 */
994
function drupal_anonymous_user($session = '') {
995
996
  $user = new stdClass();
  $user->uid = 0;
997
  $user->hostname = ip_address();
998
999
  $user->roles = array();
  $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
1000
  $user->session = $session;