bootstrap.inc 47 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
131
132
133
 * Sixth bootstrap phase: initialize the variable system.
 */
define('DRUPAL_BOOTSTRAP_VARIABLES', 5);

/**
 * Seventh bootstrap phase: load bootstrap.inc and module.inc, start
134
135
 * the variable system and try to serve a page from the cache.
 */
136
define('DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE', 6);
137
138

/**
139
 * Eighth bootstrap phase: find out language of the page.
140
 */
141
define('DRUPAL_BOOTSTRAP_LANGUAGE', 7);
142
143

/**
144
 * Nineth bootstrap phase: set $_GET['q'] to Drupal path of request.
145
 */
146
define('DRUPAL_BOOTSTRAP_PATH', 8);
147
148
149
150
151

/**
 * Final bootstrap phase: Drupal is fully loaded; validate and fix
 * input data.
 */
152
define('DRUPAL_BOOTSTRAP_FULL', 9);
153

154
155
156
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
157
define('DRUPAL_ANONYMOUS_RID', 1);
158
159
160
161

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

164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/**
 * 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);

188
189
190
/**
 * For convenience, define a short form of the request time global.
 */
191
define('REQUEST_TIME', $_SERVER['REQUEST_TIME']);
192

193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/**
 * @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
214
/**
215
 * Start the timer with the specified name. If you start and stop
Dries's avatar
   
Dries committed
216
217
218
219
220
221
222
223
224
 * the same timer multiple times, the measured intervals will be
 * accumulated.
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

225
  $timers[$name]['start'] = microtime(TRUE);
226
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
227
228
229
230
231
232
233
234
235
236
237
238
239
}

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

240
  if (isset($timers[$name]['start'])) {
241
    $stop = microtime(TRUE);
242
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
243

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

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

264
  $timers[$name]['time'] = timer_read($name);
Dries's avatar
   
Dries committed
265
266
267
268
  unset($timers[$name]['start']);

  return $timers[$name];
}
269

Dries's avatar
   
Dries committed
270
/**
271
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
272
 *
273
274
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
275
 * configuration file found will be used; the remaining will ignored. If no
276
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
277
 *
278
 * Example for a fictitious site installed at
279
280
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
281
 *
282
283
284
285
 *  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
286
 *
287
288
289
290
 *  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
291
 *
292
293
294
295
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
296
 *
297
 * 13. $confdir/default
298
 *
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 * 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.
 *
323
324
325
326
327
328
329
330
331
332
 * @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
333
 */
334
function conf_path($require_settings = TRUE, $reset = FALSE) {
Dries's avatar
Dries committed
335
  static $conf = '';
Dries's avatar
 
Dries committed
336

337
  if ($conf && !$reset) {
Dries's avatar
Dries committed
338
339
    return $conf;
  }
Dries's avatar
 
Dries committed
340

Dries's avatar
   
Dries committed
341
  $confdir = 'sites';
342
343
344
345
346
347
348

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

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

367
/**
368
369
370
371
372
 * Initialize variables needed for the rest of the execution.
 */
function drupal_initialize_variables() {
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
373
  }
374
375
376
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
377
378
379
380
  // 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);
381
382
}

383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
/**
 * Validate that $_SERVER['HTTP_HOST'] is safe.
 *
 * As $_SERVER['HTTP_HOST'] is user input, ensure it only contains characters
 * allowed in hostnames.  See RFC 952 (and RFC 2181). $_SERVER['HTTP_HOST'] is
 * lowercased.
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
function drupal_valid_http_host() {
  $_SERVER['HTTP_HOST'] = strtolower($_SERVER['HTTP_HOST']);
  return preg_match('/^\[?(?:[a-z0-9-:\]_]+\.?)+$/', $_SERVER['HTTP_HOST']);
}

398
/**
399
400
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
401
402
 */
function conf_init() {
403
404
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
405
  // Export the following settings.php variables to the global namespace
406
  global $databases, $db_prefix, $cookie_domain, $conf, $installed_profile, $update_free_access;
Dries's avatar
Dries committed
407
408
  $conf = array();

409
410
411
412
413
414
  if (!drupal_valid_http_host()) {
    // HTTP_HOST is invalid, e.g. if containing slashes it may be an attack.
    header($_SERVER['SERVER_PROTOCOL'] . ' 400 Bad Request');
    exit;
  }

415
416
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
417
  }
418
419
420
421

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
422
423
424
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
425
    $base_path = $parts['path'] . '/';
426
427
428
429
430
431
    // 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';
432

433
    $base_url = $base_root .= '://' . $_SERVER['HTTP_HOST'];
434
435
436
437

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
    if ($dir = trim(dirname($_SERVER['SCRIPT_NAME']), '\,/')) {
438
439
440
441
442
443
444
445
      $base_path = "/$dir";
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
446
447
448
449
450
451

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
452
453
454
    // 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);
455
    // We escape the hostname because it can be modified by a visitor.
456
    if (!empty($_SERVER['HTTP_HOST'])) {
457
      $cookie_domain = check_plain($_SERVER['HTTP_HOST']);
458
459
    }
  }
460
461
462
463
464
465
466
467
468
  // 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';
  }
469
470
471
472
473
  // 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);
  }
474
  $cookie_domain = explode(':', $cookie_domain);
475
  $cookie_domain = '.' . $cookie_domain[0];
476
477
478
479
480
  // 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);
  }
481
  session_name('SESS' . md5($session_name));
482
483
}

Dries's avatar
Dries committed
484
485
/**
 * Returns and optionally sets the filename for a system item (module,
486
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
487
488
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
489
490
491
492
493
494
495
496
497
498
499
500
 * 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
501
502
503
504
505
506
507
508
509
510
511
 * @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
512
function drupal_get_filename($type, $name, $filename = NULL) {
Dries's avatar
Dries committed
513
514
  static $files = array();

515
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
516
517
518
    $files[$type] = array();
  }

519
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
520
521
    $files[$type][$name] = $filename;
  }
522
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
523
524
    // nothing
  }
Dries's avatar
Dries committed
525
526
527
528
  // 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.
529
  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
530
531
532
    $files[$type][$name] = $file;
  }
  else {
Dries's avatar
Dries committed
533
534
    // 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
535
    $config = conf_path();
Dries's avatar
Dries committed
536
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
537
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
538
539
540
541
542
543
544
545
546

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

547
548
549
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
550
551
}

Dries's avatar
   
Dries committed
552
553
554
555
556
557
558
/**
 * 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
559
function variable_init($conf = array()) {
560
  // NOTE: caching the variables improves performance by 20% when serving cached pages.
561
  if ($cached = cache_get('variables', 'cache')) {
562
    $variables = $cached->data;
Dries's avatar
   
Dries committed
563
564
  }
  else {
565
    $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
566
    cache_set('variables', $variables);
Dries's avatar
   
Dries committed
567
568
569
570
  }

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

Dries's avatar
   
Dries committed
573
  return $variables;
Dries's avatar
 
Dries committed
574
575
}

Dries's avatar
   
Dries committed
576
577
578
579
580
581
582
583
584
585
/**
 * 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
586
587
588
589
590
591
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
592
593
594
595
596
597
598
599
600
/**
 * 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
601
602
603
function variable_set($name, $value) {
  global $conf;

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

606
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
607
608
609
610

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
611
612
613
614
615
616
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
617
618
619
function variable_del($name) {
  global $conf;

620
621
622
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
623
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
624
625
626
627

  unset($conf[$name]);
}

628

Dries's avatar
   
Dries committed
629
630
631
/**
 * Retrieve the current page from the cache.
 *
632
 * Note: we do not serve cached pages when status messages are waiting (from
Dries's avatar
   
Dries committed
633
634
 * a redirected form submission which was completed).
 */
Dries's avatar
 
Dries committed
635
function page_get_cache() {
636
  global $user, $base_root;
Dries's avatar
 
Dries committed
637
638

  $cache = NULL;
639

640
  if (!$user->uid && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD') && count(drupal_set_message()) == 0) {
641
    $cache = cache_get($base_root . request_uri(), 'cache_page');
Dries's avatar
 
Dries committed
642
643
644
645
646
647
648
649
650

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

  return $cache;
}

Dries's avatar
Dries committed
651
652
653
/**
 * Call all init or exit hooks without including all modules.
 *
654
 * @param $hook
Dries's avatar
Dries committed
655
656
 *   The name of the bootstrap hook we wish to invoke.
 */
657
function bootstrap_invoke_all($hook) {
658
  foreach (module_list(TRUE, TRUE) as $module) {
659
    module_invoke($module, $hook);
660
  }
Dries's avatar
Dries committed
661
662
663
}

/**
664
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
665
666
667
668
669
670
671
672
673
674
675
676
677
 * 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();

678
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
679
680
681
682
683
684
    return TRUE;
  }

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

  if ($filename) {
685
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
686
687
688
689
690
691
692
693
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

Dries's avatar
   
Dries committed
694
695
/**
 * Set HTTP headers in preparation for a page response.
696
 *
697
698
699
700
 * 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.
 *
701
 * @see page_set_cache()
Dries's avatar
   
Dries committed
702
 */
Dries's avatar
 
Dries committed
703
function drupal_page_header() {
704
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
705
  header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
706
  header("Cache-Control: store, no-cache, must-revalidate");
707
708
  header("Cache-Control: post-check=0, pre-check=0", FALSE);
}
Dries's avatar
   
Dries committed
709

710
711
712
713
714
715
716
717
718
719
720
/**
 * 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:
721
722
  $last_modified = gmdate('D, d M Y H:i:s', $cache->created) . ' GMT';
  $etag = '"' . md5($last_modified) . '"';
723
724
725
726
727
728
729
730

  // 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
731
    header($_SERVER['SERVER_PROTOCOL'] . ' 304 Not Modified');
732
733
    // All 304 responses must send an etag if the 200 response for the same object contained an etag
    header("Etag: $etag");
734
    return;
735
  }
736

737
738
739
  // Send appropriate response:
  header("Last-Modified: $last_modified");
  header("ETag: $etag");
740

741
742
743
  // The following headers force validation of cache:
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
  header("Cache-Control: must-revalidate");
744

745
746
747
748
749
750
751
752
753
  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
754
  }
755
756
757
758
759
760
761
762
763
764

  // 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
765
766
}

Dries's avatar
   
Dries committed
767
768
769
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
770
function bootstrap_hooks() {
771
  return array('boot', 'exit');
Dries's avatar
 
Dries committed
772
773
}

Dries's avatar
   
Dries committed
774
775
776
777
778
779
780
781
/**
 * 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
782
783
784
785
786
787
788
789
790
791
792
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
793
794
/**
 * Encode special characters in a plain-text string for display as HTML.
Gábor Hojtsy's avatar
Gábor Hojtsy committed
795
796
797
 *
 * Uses drupal_validate_utf8 to prevent cross site scripting attacks on
 * Internet Explorer 6.
Dries's avatar
Dries committed
798
799
 */
function check_plain($text) {
Gábor Hojtsy's avatar
Gábor Hojtsy committed
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
  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.
 *
818
819
 * The function does not return FALSE for strings containing character codes
 * above U+10FFFF, even though these are prohibited by RFC 3629.
Gábor Hojtsy's avatar
Gábor Hojtsy committed
820
821
822
823
824
825
826
827
828
829
 *
 * @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;
  }
830
831
832
  // With the PCRE_UTF8 modifier 'u', preg_match() fails silently on strings
  // containing invalid UTF-8 byte sequences. It does not reject character
  // codes above U+10FFFF (represented by 4 or more octets), though.
Gábor Hojtsy's avatar
Gábor Hojtsy committed
833
  return (preg_match('/^./us', $text) == 1);
Dries's avatar
Dries committed
834
835
}

Dries's avatar
   
Dries committed
836
/**
837
838
 * Since $_SERVER['REQUEST_URI'] is only available on Apache, we
 * generate an equivalent using other environment variables.
Dries's avatar
   
Dries committed
839
 */
Dries's avatar
 
Dries committed
840
function request_uri() {
841
842
843
844
845
846

  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
    if (isset($_SERVER['argv'])) {
847
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
848
    }
849
    elseif (isset($_SERVER['QUERY_STRING'])) {
850
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
851
    }
852
853
854
    else {
      $uri = $_SERVER['SCRIPT_NAME'];
    }
Dries's avatar
 
Dries committed
855
  }
856

857
  return $uri;
Dries's avatar
 
Dries committed
858
}
Dries's avatar
Dries committed
859

Dries's avatar
   
Dries committed
860
861
862
863
864
865
/**
 * Log a system message.
 *
 * @param $type
 *   The category to which this message belongs.
 * @param $message
866
867
 *   The message to store in the log. See t() for documentation
 *   on how $message and $variables interact. Keep $message
868
 *   translatable by not concatenating dynamic values into it!
869
870
871
872
 * @param $variables
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
873
 * @param $severity
874
 *   The severity of the message, as per RFC 3164
Dries's avatar
   
Dries committed
875
876
 * @param $link
 *   A link to associate with the message.
877
 *
878
 * @see watchdog_severity_levels()
Dries's avatar
   
Dries committed
879
 */
880
function watchdog($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
881
  global $user, $base_root;
882

883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
  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(),
899
      'referer'     => $_SERVER['HTTP_REFERER'],
900
      'ip'          => ip_address(),
901
      'timestamp'   => REQUEST_TIME,
902
903
    );

904
905
906
907
    // Call the logging hooks to log/process the message
    foreach (module_implements('watchdog', TRUE) as $module) {
      module_invoke($module, 'watchdog', $log_message);
    }
908
  }
909
  $in_error_state = FALSE;
Dries's avatar
   
Dries committed
910
911
}

Dries's avatar
   
Dries committed
912
/**
913
 * Set a message which reflects the status of the performed operation.
Dries's avatar
   
Dries committed
914
 *
915
916
 * If the function is called with no arguments, this function returns all set
 * messages without clearing them.
Dries's avatar
   
Dries committed
917
 *
918
919
920
921
922
923
 * @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'
924
 *   - 'warning'
925
 *   - 'error'
926
927
928
 * @param $repeat
 *   If this is FALSE and the message is already set, then the message won't
 *   be repeated.
Dries's avatar
   
Dries committed
929
 */
930
function drupal_set_message($message = NULL, $type = 'status', $repeat = TRUE) {
931
  if ($message) {
Dries's avatar
   
Dries committed
932
933
934
935
936
937
938
939
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

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

940
941
942
    if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type][] = $message;
    }
943
944
  }

945
946
  // messages not set when DB connection fails
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
947
948
}

Dries's avatar
   
Dries committed
949
950
951
/**
 * Return all messages that have been set.
 *
952
953
 * @param $type
 *   (optional) Only return messages of this type.
954
955
 * @param $clear_queue
 *   (optional) Set to FALSE if you do not want to clear the messages queue
956
957
958
959
960
 * @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
961
 */
962
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
963
  if ($messages = drupal_set_message()) {
964
    if ($type) {
965
      if ($clear_queue) {
966
        unset($_SESSION['messages'][$type]);
967
      }
968
969
970
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
971
972
    }
    else {
973
      if ($clear_queue) {
974
        unset($_SESSION['messages']);
975
      }
976
977
      return $messages;
    }
978
  }
979
  return array();
980
981
}

Dries's avatar
   
Dries committed
982
/**
983
984
985
986
987
988
989
990
991
 * 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.
992
993
 * @return bool
 *   TRUE if access is denied, FALSE if access is allowed.
Dries's avatar
   
Dries committed
994
 */
995
996
997
998
999
1000
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)) {