bootstrap.inc 32.5 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
39
 *
 * Severity levels, as defined in RFC 3164 http://www.faqs.org/rfcs/rfc3164.html
40
41
 * @see watchdog
 * @see watchdog_severity_levels
42
 */
43
44
45
46
47
48
49
50
define('WATCHDOG_EMERG',    0); // Emergency: system is unusable
define('WATCHDOG_ALERT',    1); // Alert: action must be taken immediately
define('WATCHDOG_CRITICAL', 2); // Critical: critical conditions
define('WATCHDOG_ERROR',    3); // Error: error conditions
define('WATCHDOG_WARNING',  4); // Warning: warning conditions
define('WATCHDOG_NOTICE',   5); // Notice: normal but significant condition
define('WATCHDOG_INFO',     6); // Informational: informational messages
define('WATCHDOG_DEBUG',    7); // Debug: debug-level messages
51

52
53
54
/**
 * First bootstrap phase: initialize configuration.
 */
55
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
56
57
58
59
60

/**
 * Second bootstrap phase: try to call a non-database cache
 * fetch routine.
 */
61
define('DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE', 1);
62
63
64
65

/**
 * Third bootstrap phase: initialize database layer.
 */
66
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
67
68
69
70

/**
 * Fourth bootstrap phase: identify and reject banned hosts.
 */
71
define('DRUPAL_BOOTSTRAP_ACCESS', 3);
72
73
74
75

/**
 * Fifth bootstrap phase: initialize session handling.
 */
76
define('DRUPAL_BOOTSTRAP_SESSION', 4);
77
78
79
80
81

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

/**
85
 * Seventh bootstrap phase: find out language of the page.
86
 */
87
88
89
90
91
92
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);

/**
 * Eighth bootstrap phase: set $_GET['q'] to Drupal path of request.
 */
define('DRUPAL_BOOTSTRAP_PATH', 7);
93
94
95
96
97

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

100
101
102
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
103
define('DRUPAL_ANONYMOUS_RID', 1);
104
105
106
107

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

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/**
 * 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);

Dries's avatar
   
Dries committed
134
/**
135
 * Start the timer with the specified name. If you start and stop
Dries's avatar
   
Dries committed
136
137
138
139
140
141
142
143
144
145
146
 * 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;
147
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
148
149
150
151
152
153
154
155
156
157
158
159
160
}

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

161
162
163
164
  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
165

166
167
168
169
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
170
  }
Dries's avatar
   
Dries committed
171
172
173
174
175
176
177
178
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
179
 *   A timer array. The array contains the number of times the
Dries's avatar
   
Dries committed
180
181
182
183
184
185
 *   timer has been started and stopped (count) and the accumulated
 *   timer value in ms (time).
 */
function timer_stop($name) {
  global $timers;

186
  $timers[$name]['time'] = timer_read($name);
Dries's avatar
   
Dries committed
187
188
189
190
  unset($timers[$name]['start']);

  return $timers[$name];
}
191

Dries's avatar
   
Dries committed
192
/**
193
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
194
 *
195
196
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
197
 * configuration file found will be used; the remaining will ignored. If no
198
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
199
 *
200
 * Example for a fictitious site installed at
201
202
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
203
 *
204
205
206
207
 *  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
208
 *
209
210
211
212
 *  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
213
 *
214
215
216
217
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
218
 *
219
 * 13. $confdir/default
Dries's avatar
   
Dries committed
220
 */
221
function conf_path() {
Dries's avatar
Dries committed
222
  static $conf = '';
Dries's avatar
 
Dries committed
223

Dries's avatar
Dries committed
224
225
226
  if ($conf) {
    return $conf;
  }
Dries's avatar
 
Dries committed
227

Dries's avatar
   
Dries committed
228
  $confdir = 'sites';
229
  $uri = explode('/', $_SERVER['PHP_SELF'] ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_FILENAME']);
230
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
231
232
233
234
235
236
237
  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));
      if (file_exists("$confdir/$dir/settings.php")) {
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
238
239
    }
  }
Dries's avatar
Dries committed
240
241
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
242
243
}

244
245
246
247
248
/**
 * Unsets all disallowed global variables. See $allowed for what's allowed.
 */
function drupal_unset_globals() {
  if (ini_get('register_globals')) {
249
    $allowed = array('_ENV' => 1, '_GET' => 1, '_POST' => 1, '_COOKIE' => 1, '_FILES' => 1, '_SERVER' => 1, '_REQUEST' => 1, 'access_check' => 1, 'GLOBALS' => 1);
250
    foreach ($GLOBALS as $key => $value) {
251
252
253
254
255
256
257
      if (!isset($allowed[$key])) {
        unset($GLOBALS[$key]);
      }
    }
  }
}

258
/**
259
260
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
261
262
 */
function conf_init() {
263
264
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
265
  // Export the following settings.php variables to the global namespace
266
  global $db_url, $db_prefix, $cookie_domain, $conf, $installed_profile;
Dries's avatar
Dries committed
267
268
  $conf = array();

269
270
271
  if (file_exists('./'. conf_path() .'/settings.php')) {
    include_once './'. conf_path() .'/settings.php';
  }
272
273
274
275

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
276
277
278
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
279
    $base_path = $parts['path'] .'/';
280
281
282
283
284
285
286
    // 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';
    $base_url = $base_root .= '://'. $_SERVER['HTTP_HOST'];
287
    if ($dir = trim(dirname($_SERVER['PHP_SELF']), '\,/')) {
288
289
290
291
292
293
294
295
      $base_path = "/$dir";
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
296
297
298
299
300
301

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
302
303
304
    // 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);
305
306
307
308
309
310
311
312
313
314
    // We try to set the cookie domain to the hostname.
    if (!empty($_SERVER['HTTP_HOST'])) {
      $cookie_domain = $_SERVER['HTTP_HOST'];
    }
  }
  // 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);
  }
315
316
  $cookie_domain = explode(':', $cookie_domain);
  $cookie_domain = '.'. array_shift($cookie_domain);
317
318
319
320
321
322
  // 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);
  }
  session_name('SESS'. md5($session_name));
323
324
}

Dries's avatar
Dries committed
325
326
/**
 * Returns and optionally sets the filename for a system item (module,
327
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
328
329
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
330
331
332
333
334
335
336
337
338
339
340
341
 * 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
342
343
344
345
346
347
348
349
350
351
352
 * @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
353
function drupal_get_filename($type, $name, $filename = NULL) {
Dries's avatar
Dries committed
354
  static $files = array();
Dries's avatar
Dries committed
355
  global $active_db;
Dries's avatar
Dries committed
356

357
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
358
359
360
    $files[$type] = array();
  }

361
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
362
363
    $files[$type][$name] = $filename;
  }
364
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
365
366
    // nothing
  }
Dries's avatar
Dries committed
367
368
369
370
371
  // 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.
  elseif ($active_db && (($file = db_result(db_query("SELECT filename FROM {system} WHERE name = '%s' AND type = '%s'", $name, $type))) && file_exists($file))) {
Dries's avatar
Dries committed
372
373
374
    $files[$type][$name] = $file;
  }
  else {
Dries's avatar
Dries committed
375
376
    // 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
377
    $config = conf_path();
Dries's avatar
Dries committed
378
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
379
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
380
381
382
383
384
385
386
387
388

    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;
      }
    }
  }

389
390
391
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
392
393
}

Dries's avatar
   
Dries committed
394
395
396
397
398
399
400
/**
 * 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
401
function variable_init($conf = array()) {
402
  // NOTE: caching the variables improves performance by 20% when serving cached pages.
403
  if ($cached = cache_get('variables', 'cache')) {
404
    $variables = $cached->data;
Dries's avatar
   
Dries committed
405
406
407
408
409
  }
  else {
    $result = db_query('SELECT * FROM {variable}');
    while ($variable = db_fetch_object($result)) {
      $variables[$variable->name] = unserialize($variable->value);
Dries's avatar
 
Dries committed
410
    }
411
    cache_set('variables', $variables);
Dries's avatar
   
Dries committed
412
413
414
415
  }

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

Dries's avatar
   
Dries committed
418
  return $variables;
Dries's avatar
 
Dries committed
419
420
}

Dries's avatar
   
Dries committed
421
422
423
424
425
426
427
428
429
430
/**
 * 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
431
432
433
434
435
436
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
437
438
439
440
441
442
443
444
445
/**
 * 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
446
447
448
function variable_set($name, $value) {
  global $conf;

449
450
451
452
453
  $serialized_value = serialize($value);
  db_query("UPDATE {variable} SET value = '%s' WHERE name = '%s'", $serialized_value, $name);
  if (!db_affected_rows()) {
    @db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", $name, $serialized_value);
  }
Dries's avatar
   
Dries committed
454

455
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
456
457
458
459

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
460
461
462
463
464
465
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
466
467
468
469
function variable_del($name) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
470
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
471
472
473
474

  unset($conf[$name]);
}

475

Dries's avatar
   
Dries committed
476
477
478
/**
 * Retrieve the current page from the cache.
 *
479
 * Note: we do not serve cached pages when status messages are waiting (from
Dries's avatar
   
Dries committed
480
481
 * a redirected form submission which was completed).
 */
Dries's avatar
 
Dries committed
482
function page_get_cache() {
483
  global $user, $base_root;
Dries's avatar
 
Dries committed
484
485

  $cache = NULL;
486

487
  if (!$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET' && count(drupal_set_message()) == 0) {
488
    $cache = cache_get($base_root . request_uri(), 'cache_page');
Dries's avatar
 
Dries committed
489
490
491
492
493
494
495
496
497

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

  return $cache;
}

Dries's avatar
Dries committed
498
499
500
/**
 * Call all init or exit hooks without including all modules.
 *
501
 * @param $hook
Dries's avatar
Dries committed
502
503
 *   The name of the bootstrap hook we wish to invoke.
 */
504
function bootstrap_invoke_all($hook) {
505
  foreach (module_list(TRUE, TRUE) as $module) {
Dries's avatar
Dries committed
506
    drupal_load('module', $module);
507
    module_invoke($module, $hook);
Dries's avatar
Dries committed
508
509
510
511
 }
}

/**
512
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
513
514
515
516
517
518
519
520
521
522
523
524
525
 * 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();

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

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

  if ($filename) {
533
    include_once "./$filename";
Dries's avatar
Dries committed
534
535
536
537
538
539
540
541
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

Dries's avatar
   
Dries committed
542
543
/**
 * Set HTTP headers in preparation for a page response.
544
 *
545
546
547
548
 * 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.
 *
549
 * @see page_set_cache
Dries's avatar
   
Dries committed
550
 */
Dries's avatar
 
Dries committed
551
function drupal_page_header() {
552
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
553
  header("Last-Modified: ". gmdate("D, d M Y H:i:s") ." GMT");
554
  header("Cache-Control: store, no-cache, must-revalidate");
555
556
  header("Cache-Control: post-check=0, pre-check=0", FALSE);
}
Dries's avatar
   
Dries committed
557

558
559
560
561
562
563
564
565
566
567
568
569
/**
 * 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:
  $last_modified = gmdate('D, d M Y H:i:s', $cache->created) .' GMT';
570
  $etag = '"'. md5($last_modified) .'"';
571
572
573
574
575
576
577
578
579
580
581
582
583

  // 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
    header('HTTP/1.1 304 Not Modified');
    // All 304 responses must send an etag if the 200 response for the same object contained an etag
    header("Etag: $etag");
    exit();
  }
584

585
586
587
  // Send appropriate response:
  header("Last-Modified: $last_modified");
  header("ETag: $etag");
588

589
590
591
  // The following headers force validation of cache:
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
  header("Cache-Control: must-revalidate");
592

593
594
595
596
  // 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));
597
  }
598
599
  elseif (function_exists('gzencode')) {
    header('Content-Encoding: gzip');
Dries's avatar
 
Dries committed
600
  }
601
602
603
604
605
606
607
608
609
610

  // 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
611
612
}

Dries's avatar
   
Dries committed
613
614
615
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
616
function bootstrap_hooks() {
617
  return array('boot', 'exit');
Dries's avatar
 
Dries committed
618
619
}

Dries's avatar
   
Dries committed
620
621
622
623
624
625
626
627
/**
 * 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
628
629
630
631
632
633
634
635
636
637
638
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
639
640
641
/**
 * Return the URI of the referring page.
 */
Dries's avatar
 
Dries committed
642
function referer_uri() {
643
  if (isset($_SERVER['HTTP_REFERER'])) {
644
    return $_SERVER['HTTP_REFERER'];
Dries's avatar
 
Dries committed
645
646
647
  }
}

Dries's avatar
Dries committed
648
649
650
651
652
653
654
/**
 * Encode special characters in a plain-text string for display as HTML.
 */
function check_plain($text) {
  return htmlspecialchars($text, ENT_QUOTES);
}

Dries's avatar
   
Dries committed
655
/**
656
657
 * Since $_SERVER['REQUEST_URI'] is only available on Apache, we
 * generate an equivalent using other environment variables.
Dries's avatar
   
Dries committed
658
 */
Dries's avatar
 
Dries committed
659
function request_uri() {
660
661
662
663
664
665
666

  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
    if (isset($_SERVER['argv'])) {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['argv'][0];
667
668
    }
    else {
669
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['QUERY_STRING'];
670
    }
Dries's avatar
 
Dries committed
671
  }
672

673
  return $uri;
Dries's avatar
 
Dries committed
674
}
Dries's avatar
Dries committed
675

Dries's avatar
   
Dries committed
676
677
678
679
680
681
/**
 * Log a system message.
 *
 * @param $type
 *   The category to which this message belongs.
 * @param $message
682
683
 *   The message to store in the log. See t() for documentation
 *   on how $message and $variables interact. Keep $message
684
 *   translatable by not concatenating dynamic values into it!
685
686
687
688
 * @param $variables
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
689
 * @param $severity
690
 *   The severity of the message, as per RFC 3164
Dries's avatar
   
Dries committed
691
692
 * @param $link
 *   A link to associate with the message.
693
694
 *
 * @see watchdog_severity_levels
Dries's avatar
   
Dries committed
695
 */
696
function watchdog($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
697
  global $user, $base_root;
698

699
700
701
702
  // Prepare the fields to be logged
  $log_message = array(
    'type'        => $type,
    'message'     => $message,
703
    'variables'   => $variables,
704
705
706
707
708
    'severity'    => $severity,
    'link'        => $link,
    'user'        => $user,
    'request_uri' => $base_root . request_uri(),
    'referer'     => referer_uri(),
709
    'ip'          => ip_address(),
710
711
712
713
714
715
    'timestamp'   => time(),
    );

  // Call the logging hooks to log/process the message
  foreach (module_implements('watchdog', TRUE) as $module) {
    module_invoke($module, 'watchdog', $log_message);
716
  }
Dries's avatar
   
Dries committed
717
718
}

Dries's avatar
   
Dries committed
719
/**
720
 * Set a message which reflects the status of the performed operation.
Dries's avatar
   
Dries committed
721
 *
722
723
 * If the function is called with no arguments, this function returns all set
 * messages without clearing them.
Dries's avatar
   
Dries committed
724
 *
725
726
727
728
729
730
731
 * @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'
 *   - 'error'
Dries's avatar
   
Dries committed
732
733
 */
function drupal_set_message($message = NULL, $type = 'status') {
734
  if ($message) {
Dries's avatar
   
Dries committed
735
736
737
738
739
740
741
742
743
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

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

    $_SESSION['messages'][$type][] = $message;
744
745
  }

746
747
  // messages not set when DB connection fails
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
748
749
}

Dries's avatar
   
Dries committed
750
751
752
/**
 * Return all messages that have been set.
 *
753
754
 * @param $type
 *   (optional) Only return messages of this type.
755
756
 * @param $clear_queue
 *   (optional) Set to FALSE if you do not want to clear the messages queue
757
758
759
760
761
 * @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
762
 */
763
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
764
  if ($messages = drupal_set_message()) {
765
    if ($type) {
766
767
768
      if ($clear_queue) {
         unset($_SESSION['messages'][$type]);
      }
769
770
771
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
772
773
    }
    else {
774
775
776
      if ($clear_queue) {
         unset($_SESSION['messages']);
      }
777
778
      return $messages;
    }
779
  }
780
  return array();
781
782
}

Dries's avatar
   
Dries committed
783
/**
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 * Perform an access check for a given mask and rule type. Rules are usually
 * created via admin/user/rules page.
 *
 * If any allow rule matches, access is allowed. Otherwise, if any deny rule
 * matches, access is denied.  If no rule matches, access is allowed.
 *
 * @param $type string
 *   Type of access to check: Allowed values are:
 *     - 'host': host name or IP address
 *     - 'mail': e-mail address
 *     - 'user': username
 * @param $mask string
 *   String or mask to test: '_' matches any character, '%' matches any
 *   number of characters.
 * @return bool
 *   TRUE if access is denied, FALSE if access is allowed.
Dries's avatar
   
Dries committed
800
 */
801
function drupal_is_denied($type, $mask) {
802
803
804
805
806
807
808
809
810
811
812
813
  // Because this function is called for every page request, both cached
  // and non-cached pages, we tried to optimize it as much as possible.
  // We deny access if the only matching records in the {access} table have
  // status 0. If any have status 1, or if there are no matching records,
  // we allow access. So, select matching records in decreasing order of
  // 'status', returning NOT(status) for the first. If any have status 1,
  // they come first, and we return NOT(status) = 0 (allowed). Otherwise,
  // if we have some with status 0, we return 1 (denied). If no matching
  // records, we get no return from db_result, so we return (bool)NULL = 0
  // (allowed).
  // The use of ORDER BY / LIMIT is more efficient than "MAX(status) = 0"
  // in PostgreSQL <= 8.0.
814
  return (bool) db_result(db_query_range("SELECT CASE WHEN status=1 THEN 0 ELSE 1 END FROM {access} WHERE type = '%s' AND LOWER('%s') LIKE LOWER(mask) ORDER BY status DESC", $type, $mask, 0, 1));
Dries's avatar
   
Dries committed
815
816
}

817
/**
818
 * Generates a default anonymous $user object.
819
820
821
 *
 * @return Object - the user object.
 */
822
function drupal_anonymous_user($session = '') {
823
824
  $user = new stdClass();
  $user->uid = 0;
825
  $user->hostname = ip_address();
826
827
  $user->roles = array();
  $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
828
  $user->session = $session;
829
  $user->cache = 0;
830
831
832
  return $user;
}

833
834
835
/**
 * A string describing a phase of Drupal to load. Each phase adds to the
 * previous one, so invoking a later phase automatically runs the earlier
836
 * phases too. The most important usage is that if you want to access the
837
 * Drupal database from a script without loading anything else, you can
838
 * include bootstrap.inc, and call drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE).
839
840
 *
 * @param $phase
841
 *   A constant. Allowed values are:
842
843
 *     DRUPAL_BOOTSTRAP_CONFIGURATION: initialize configuration.
 *     DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE: try to call a non-database cache fetch routine.
844
 *     DRUPAL_BOOTSTRAP_DATABASE: initialize database layer.
845
 *     DRUPAL_BOOTSTRAP_ACCESS: identify and reject banned hosts.
846
 *     DRUPAL_BOOTSTRAP_SESSION: initialize session handling.
847
 *     DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE: load bootstrap.inc and module.inc, start
848
 *       the variable system and try to serve a page from the cache.
849
 *     DRUPAL_BOOTSTRAP_LANGUAGE: identify the language used on the page.
850
 *     DRUPAL_BOOTSTRAP_PATH: set $_GET['q'] to Drupal path of request.
851
 *     DRUPAL_BOOTSTRAP_FULL: Drupal is fully loaded, validate and fix input data.
852
853
 */
function drupal_bootstrap($phase) {
854
  static $phases = array(DRUPAL_BOOTSTRAP_CONFIGURATION, DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE, DRUPAL_BOOTSTRAP_DATABASE, DRUPAL_BOOTSTRAP_ACCESS, DRUPAL_BOOTSTRAP_SESSION, DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE, DRUPAL_BOOTSTRAP_LANGUAGE, DRUPAL_BOOTSTRAP_PATH, DRUPAL_BOOTSTRAP_FULL);
855

856
857
858
859
860
  // Stop early if $phase was already executed.
  if (!in_array($phase, $phases)) {
    return;
  }

861
  while (!is_null($current_phase = array_shift($phases))) {
862
863
864
865
866
867
    _drupal_bootstrap($current_phase);
    if ($phase == $current_phase) {
      return;
    }
  }
}
Dries's avatar
   
Dries committed
868

869
870
function _drupal_bootstrap($phase) {
  global $conf;
Dries's avatar
 
Dries committed
871

872
  switch ($phase) {
873

874
    case DRUPAL_BOOTSTRAP_CONFIGURATION:
875
      drupal_unset_globals();
876
877
      // Initialize the configuration
      conf_init();
878
      break;
879

880
    case DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE:
881
      _drupal_cache_init($phase);
882
      break;
883

884
    case DRUPAL_BOOTSTRAP_DATABASE:
885
      // Initialize the default database.
886
      require_once './includes/database.inc';
887
888
      db_set_active();
      break;
889

890
891
    case DRUPAL_BOOTSTRAP_ACCESS:
      // Deny access to hosts which were banned - t() is not yet available.
892
      if (drupal_is_denied('host', ip_address())) {
893
        header('HTTP/1.1 403 Forbidden');
894
        print 'Sorry, '. check_plain(ip_address()) .' has been banned.';
895
896
897
898
        exit();
      }
      break;

899
    case DRUPAL_BOOTSTRAP_SESSION:
900
      require_once variable_get('session_inc', './includes/session.inc');
901
      session_set_save_handler('sess_open', 'sess_close', 'sess_read', 'sess_write', 'sess_destroy_sid', 'sess_gc');
902
903
      session_start();
      break;
904

905
    case DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE:
906
907
908
909
      // Initialize configuration variables, using values from settings.php if available.
      $conf = variable_init(isset($conf) ? $conf : array());

      _drupal_cache_init($phase);
910

911
912
913
      // Start a page timer:
      timer_start('page');

914
915
      drupal_page_header();
      break;
916

917
918
919
920
    case DRUPAL_BOOTSTRAP_LANGUAGE:
      drupal_init_language();
      break;

921
922
923
924
925
926
    case DRUPAL_BOOTSTRAP_PATH:
      require_once './includes/path.inc';
      // Initialize $_GET['q'] prior to loading modules and invoking hook_init().
      drupal_init_path();
      break;

927
    case DRUPAL_BOOTSTRAP_FULL:
928
929
930
931
      require_once './includes/common.inc';
      _drupal_bootstrap_full();
      break;
  }
Dries's avatar
   
Dries committed
932
933
}

934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
/**
 * Initialize the caching strategy, which loads at different stages within
 * Drupal's bootstrap process.
 */
function _drupal_cache_init($phase) {
  require_once variable_get('cache_inc', './includes/cache.inc');

  if ($phase == DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE && variable_get('page_cache_fastpath', 0)) {
    if (page_cache_fastpath()) {
      exit();
    }
  }
  elseif ($phase == DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE) {
    if ($cache = page_get_cache()) {
      if (variable_get('cache', CACHE_DISABLED) == CACHE_AGGRESSIVE) {
        drupal_page_cache_header($cache);
        exit();
      }
      elseif (variable_get('cache', CACHE_DISABLED) == CACHE_NORMAL) {
        require_once './includes/module.inc';
954
        bootstrap_invoke_all('boot');
955
956
957
958
959
960
961
962
963
        drupal_page_cache_header($cache);
        bootstrap_invoke_all('exit');
        exit();
      }
    }
    require_once './includes/module.inc';
  }
}

964
965
966
/**
 * Enables use of the theme system without requiring database access. Since
 * there is not database access no theme will be enabled and the default
967
 * themeable functions will be called. Some themeable functions can not be used
968
969
970
971
972
 * without the full Drupal API loaded. For example, theme_page() is
 * unavailable and theme_maintenance_page() must be used in its place.
 */
function drupal_maintenance_theme() {
  global $theme;
973
  require_once './includes/path.inc';
974
975
976
  require_once './includes/theme.inc';
  require_once './includes/common.inc';
  require_once './includes/unicode.inc';
977
  require_once './modules/filter/filter.module';
978
  unicode_check();
979
980
  drupal_add_css(drupal_get_path('module', 'system') .'/defaults.css', 'module');
  drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'module');
981
  $theme = '';
982
983
984
985
986

  // Special case registry of theme functions used by the installer
  $themes = drupal_common_themes();
  foreach ($themes as $hook => $info) {
    if (!isset($info['file']) && !isset($info['function'])) {
987
      $themes[$hook]['function'] = 'theme_'. $hook;
988
      $themes[$hook]['theme path'] = 'misc';
989
990
991
    }
  }
  _theme_set_registry($themes);
992
}
993
994
995
996
997
998
999
1000

/**
 * Return the name of the localisation function. Use in code that needs to
 * run both during installation and normal operation.
 */
function get_t() {
  static $t;
  if (is_null($t)) {
For faster browsing, not all history is shown. View entire blame