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

Dries's avatar
   
Dries committed
4
5
6
7
8
9
10
11
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/**
 * Return status for saving which involved creating a new item.
 */
define('SAVED_NEW', 1);

/**
 * Return status for saving which involved an update to an existing item.
 */
define('SAVED_UPDATED', 2);

/**
 * Return status for saving which deleted an existing item.
 */
define('SAVED_DELETED', 3);

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
function drupal_set_content($region = null, $data = null) {
  static $content = array();

  if (!is_null($region) && !is_null($data)) {
    $content[$region][] = $data;
  }
  return $content;
}

/**
 * Get assigned content.
 *
 * @param $region
 *   A specified region to fetch content for.  If null, all regions will be returned.
 *
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
54
function drupal_get_content($region = NULL, $delimiter = ' ') {
55
  $content = drupal_set_content();
56
57
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
58
      return implode($delimiter, $content[$region]);
59
    }
60
61
62
63
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
64
        $content[$region] = implode($delimiter, $content[$region]);
65
66
67
68
69
70
      }
    }
    return $content;
  }
}

Dries's avatar
   
Dries committed
71
/**
Dries's avatar
   
Dries committed
72
 * Set the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
73
 *
Dries's avatar
   
Dries committed
74
75
76
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
77
 */
Dries's avatar
   
Dries committed
78
79
80
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

81
  if (!is_null($breadcrumb)) {
Dries's avatar
   
Dries committed
82
83
84
85
86
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
87
88
89
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
   
Dries committed
90
91
92
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

93
  if (is_null($breadcrumb)) {
Dries's avatar
   
Dries committed
94
95
96
97
98
99
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
100
/**
Dries's avatar
   
Dries committed
101
 * Add output to the head tag of the HTML page.
Dries's avatar
   
Dries committed
102
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
103
104
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
   
Dries committed
105
  static $stored_head = '';
Dries's avatar
Dries committed
106
107

  if (!is_null($data)) {
Dries's avatar
   
Dries committed
108
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
109
110
111
112
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
113
114
115
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
116
117
118
function drupal_get_html_head() {
  global $base_url;

Dries's avatar
   
Dries committed
119
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
120
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
   
Dries committed
121
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
122
123
124
125

  return $output . drupal_set_html_head();
}

Dries's avatar
   
Dries committed
126
/**
127
 * Reset the static variable which holds the aliases mapped for this request.
Dries's avatar
   
Dries committed
128
 */
129
130
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries's avatar
   
Dries committed
131
}
Kjartan's avatar
Kjartan committed
132

Dries's avatar
   
Dries committed
133
/**
Dries's avatar
   
Dries committed
134
 * Given a path alias, return the internal path it represents.
Dries's avatar
   
Dries committed
135
136
 */
function drupal_get_normal_path($path) {
137
138
139
  $result = $path;
  if ($src = drupal_lookup_path('source', $path)) {
    $result = $src;
Dries's avatar
   
Dries committed
140
  }
141
142
  if (function_exists('custom_url_rewrite')) {
    $result = custom_url_rewrite('source', $result, $path);
Dries's avatar
   
Dries committed
143
  }
144
  return $result;
Dries's avatar
   
Dries committed
145
}
Kjartan's avatar
Kjartan committed
146

Dries's avatar
Dries committed
147
/**
Dries's avatar
   
Dries committed
148
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
149
150
 */
function drupal_set_header($header = NULL) {
151
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
   
Dries committed
152
  // Otherwise, header('') could get called when serving the page later, which
153
154
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
155

156
  if (strlen($header)) {
Dries's avatar
Dries committed
157
    header($header);
158
    $stored_headers[] = $header;
Dries's avatar
Dries committed
159
  }
160
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
161
162
}

Dries's avatar
   
Dries committed
163
164
165
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
166
167
168
169
function drupal_get_headers() {
  return drupal_set_header();
}

Dries's avatar
   
Dries committed
170
171
172
/**
 * @name HTTP handling
 * @{
Dries's avatar
   
Dries committed
173
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
174
175
 */

176
177
/**
 * Prepare a destination query string for use in combination with
178
179
180
181
182
 * drupal_goto(). Used to direct the user back to the referring page
 * after completing a form. By default the current URL is returned.
 * If a destination exists in the previous request, that destination
 * is returned.  As such, a destination can persist across multiple
 * pages.
183
184
185
186
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
187
188
189
190
191
192
193
194
195
196
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
    $destination[] = $_GET['q'];
    $params = array('page', 'sort', 'order');
    foreach ($params as $param) {
      if (isset($_GET[$param])) {
        $destination[] = "$param=". $_GET[$param];
      }
197
    }
198
    return 'destination='. urlencode(implode('&', $destination));
199
200
201
  }
}

Kjartan's avatar
Kjartan committed
202
/**
Dries's avatar
   
Dries committed
203
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
204
 *
Dries's avatar
   
Dries committed
205
206
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
207
 *
208
209
210
211
212
213
214
215
216
217
 * Usually the redirected URL is constructed from this function's input
 * parameters.  However you may override that behavior by setting a
 * <em>destination</em> in either the $_REQUEST-array (i.e. by using
 * the query string of an URI) or the $_REQUEST['edit']-array (i.e. by
 * using a hidden form field).  This is used to direct the user back to
 * the proper page after completing a form.  For example, after editing
 * a post on the 'admin/node'-page or after having logged on using the
 * 'user login'-block in a sidebar.  The function drupal_get_destination()
 * can be used to help set the destination URL.
 *
Dries's avatar
   
Dries committed
218
219
220
221
222
223
224
225
226
227
228
229
230
 * It is advised to use drupal_goto() instead of PHP's header(), because
 * drupal_goto() will append the user's session ID to the URI when PHP is
 * compiled with "--enable-trans-sid".
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
 *   A Drupal path.
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
231
232
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
233
 */
Dries's avatar
   
Dries committed
234
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
235
236
237
238
239
240
241
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

242
  $url = url($path, $query, $fragment, TRUE);
Kjartan's avatar
Kjartan committed
243

Dries's avatar
   
Dries committed
244
245
246
247
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

  header('Location: '. $url);
Kjartan's avatar
Kjartan committed
248

Dries's avatar
   
Dries committed
249
250
251
  // The "Location" header sends a REDIRECT status code to the http
  // daemon. In some cases this can go wrong, so we make sure none
  // of the code below the drupal_goto() call gets executed when we redirect.
Kjartan's avatar
Kjartan committed
252
253
254
  exit();
}

255
256
257
258
259

/**
 * Generates a site offline message
 */
function drupal_site_offline() {
260
  drupal_set_header('HTTP/1.0 503 Service unavailable');
261
262
  drupal_set_title(t('Site offline'));
  print theme('maintenance_page', variable_get('site_offline_message',
263
    t('%site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('%site' => variable_get('site_name', t('This Drupal site'))))));
264
265
}

Kjartan's avatar
Kjartan committed
266
267
268
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
269
function drupal_not_found() {
270
  drupal_set_header('HTTP/1.0 404 Not Found');
271
  watchdog('page not found', t('%page not found.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING);
Dries's avatar
   
Dries committed
272
273

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
   
Dries committed
274
  $status = MENU_NOT_FOUND;
Dries's avatar
   
Dries committed
275
276
  if ($path) {
    menu_set_active_item($path);
277
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
278
279
  }

280
  if (empty($return)) {
281
    drupal_set_title(t('Page not found'));
Dries's avatar
   
Dries committed
282
  }
283
  print theme('page', $return);
Dries's avatar
   
Dries committed
284
}
Dries's avatar
   
Dries committed
285

Dries's avatar
   
Dries committed
286
287
288
289
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
290
  drupal_set_header('HTTP/1.0 403 Forbidden');
291
  watchdog('access denied', t('%page denied access.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries's avatar
   
Dries committed
292
293

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
   
Dries committed
294
  $status = MENU_NOT_FOUND;
Dries's avatar
   
Dries committed
295
296
  if ($path) {
    menu_set_active_item($path);
297
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
298
299
  }

300
  if (empty($return)) {
301
    drupal_set_title(t('Access denied'));
302
    $return = t('You are not authorized to access this page.');
Dries's avatar
   
Dries committed
303
  }
304
  print theme('page', $return);
Dries's avatar
   
Dries committed
305
306
}

Dries's avatar
   
Dries committed
307
/**
Dries's avatar
   
Dries committed
308
 * Perform an HTTP request.
Dries's avatar
   
Dries committed
309
 *
Dries's avatar
   
Dries committed
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 * This is a flexible and powerful HTTP client implementation. Correctly handles
 * GET, POST, PUT or any other HTTP requests. Handles redirects.
 *
 * @param $url
 *   A string containing a fully qualified URI.
 * @param $headers
 *   An array containing an HTTP header => value pair.
 * @param $method
 *   A string defining the HTTP request to use.
 * @param $data
 *   A string containing data to include in the request.
 * @param $retry
 *   An integer representing how many times to retry the request in case of a
 *   redirect.
 * @return
 *   An object containing the HTTP request headers, response code, headers,
 *   data, and redirect status.
Dries's avatar
   
Dries committed
327
328
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
   
Dries committed
329
330
  $result = new StdClass();

Dries's avatar
   
Dries committed
331
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
   
Dries committed
332
333
334
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
335
      $port = isset($uri['port']) ? $uri['port'] : 80;
336
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries's avatar
   
Dries committed
337
338
      break;
    case 'https':
Dries's avatar
   
Dries committed
339
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
Dries's avatar
Dries committed
340
      $port = isset($uri['port']) ? $uri['port'] : 443;
341
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries's avatar
   
Dries committed
342
343
      break;
    default:
Dries's avatar
   
Dries committed
344
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
   
Dries committed
345
346
347
      return $result;
  }

Dries's avatar
   
Dries committed
348
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
349
  if (!$fp) {
Dries's avatar
   
Dries committed
350
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
   
Dries committed
351
352
353
    return $result;
  }

Dries's avatar
   
Dries committed
354
  // Construct the path to act on.
Dries's avatar
Dries committed
355
356
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
   
Dries committed
357
    $path .= '?'. $uri['query'];
Dries's avatar
   
Dries committed
358
359
  }

Dries's avatar
   
Dries committed
360
  // Create HTTP request.
Dries's avatar
   
Dries committed
361
  $defaults = array(
362
363
    // RFC 2616: "non-standard ports MUST, default ports MAY be included". We always add it.
    'Host' => "Host: $uri[host]:$port",
364
365
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
366
367
368
  );

  foreach ($headers as $header => $value) {
Dries's avatar
   
Dries committed
369
    $defaults[$header] = $header .': '. $value;
Dries's avatar
   
Dries committed
370
371
  }

Dries's avatar
   
Dries committed
372
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
   
Dries committed
373
374
375
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
   
Dries committed
376
    $request .= $data ."\r\n";
Dries's avatar
   
Dries committed
377
378
379
380
381
382
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
383
  $response = '';
384
  while (!feof($fp) && $data = fread($fp, 1024)) {
385
    $response .= $data;
Dries's avatar
   
Dries committed
386
387
388
389
  }
  fclose($fp);

  // Parse response.
390
391
392
393
  list($headers, $result->data) = explode("\r\n\r\n", $response, 2);
  $headers = preg_split("/\r\n|\n|\r/", $headers);

  list($protocol, $code, $text) = explode(' ', trim(array_shift($headers)), 3);
Dries's avatar
   
Dries committed
394
395
396
  $result->headers = array();

  // Parse headers.
397
  while ($line = trim(array_shift($headers))) {
Dries's avatar
   
Dries committed
398
    list($header, $value) = explode(':', $line, 2);
399
400
401
402
403
404
405
406
    if (isset($result->headers[$header]) && $header == 'Set-Cookie') {
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
      $result->headers[$header] .= ','. trim($value);
    }
    else {
      $result->headers[$header] = trim($value);
    }
Dries's avatar
   
Dries committed
407
408
409
410
411
412
413
414
415
416
  }

  $responses = array(
    100 => 'Continue', 101 => 'Switching Protocols',
    200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content',
    300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect',
    400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed',
    500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported'
  );
  // RFC 2616 states that all unknown HTTP codes must be treated the same as
Dries's avatar
   
Dries committed
417
  // the base code in their class.
Dries's avatar
   
Dries committed
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
      $location = $result->headers['Location'];

      if ($retry) {
        $result = drupal_http_request($result->headers['Location'], $headers, $method, $data, --$retry);
        $result->redirect_code = $result->code;
      }
      $result->redirect_url = $location;

      break;
    default:
      $result->error = $text;
  }

  $result->code = $code;
  return $result;
}
Dries's avatar
   
Dries committed
445
446
447
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
448

Dries's avatar
   
Dries committed
449
/**
Dries's avatar
   
Dries committed
450
451
 * Log errors as defined by administrator
 * Error levels:
452
453
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries's avatar
   
Dries committed
454
 */
Dries's avatar
   
Dries committed
455
function error_handler($errno, $message, $filename, $line) {
456
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
   
Dries committed
457
458
    $types = array(1 => 'error', 2 => 'warning', 4 => 'parse error', 8 => 'notice', 16 => 'core error', 32 => 'core warning', 64 => 'compile error', 128 => 'compile warning', 256 => 'user error', 512 => 'user warning', 1024 => 'user notice', 2048 => 'strict warning');
    $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
   
Dries committed
459

Dries's avatar
   
Dries committed
460
    if (variable_get('error_level', 1) == 1) {
461
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
462
    }
463
464

    watchdog('php', t('%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)), WATCHDOG_ERROR);
Dries's avatar
   
Dries committed
465
466
467
  }
}

Dries's avatar
   
Dries committed
468
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
469
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
470
471
472
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
473
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
474
475
476
  }
}

Dries's avatar
   
Dries committed
477
478
479
480
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
   
Dries committed
481
482
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
   
Dries committed
483
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
484
485
486
487
488
489
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
    $fixed = true;
  }
Dries's avatar
   
Dries committed
490
491
}

Kjartan's avatar
Kjartan committed
492
493
494
/**
 * @name Messages
 * @{
Dries's avatar
   
Dries committed
495
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
496
 */
Dries's avatar
   
Dries committed
497
498
499
500

/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
   
Dries committed
501
function message_na() {
Dries's avatar
   
Dries committed
502
  return t('n/a');
Dries's avatar
   
Dries committed
503
504
}

Dries's avatar
   
Dries committed
505
506
507
/**
 * @} End of "Messages".
 */
Dries's avatar
   
Dries committed
508

Dries's avatar
   
Dries committed
509
510
511
/**
 * Initialize the localization system.
 */
Dries's avatar
   
Dries committed
512
513
function locale_initialize() {
  global $user;
Dries's avatar
   
Dries committed
514
515
516
517
518

  if (function_exists('i18n_get_lang')) {
    return i18n_get_lang();
  }

Dries's avatar
   
Dries committed
519
520
521
522
523
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
524
525
526
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
Dries's avatar
   
Dries committed
527
  }
528
  if ($user->uid && isset($languages[$user->language])) {
Dries's avatar
   
Dries committed
529
530
531
532
533
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
534
535
}

Kjartan's avatar
Kjartan committed
536
/**
Dries's avatar
   
Dries committed
537
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
538
 *
539
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
   
Dries committed
540
541
542
543
 * This makes it easier for translators. HTML markup within translation strings
 * is acceptable, if necessary. The suggested syntax for a link embedded
 * within a translation string is:
 * @code
Dries's avatar
   
Dries committed
544
545
546
 *   $msg = t('You must log in below or <a href="%url">create a new
 *             account</a> before viewing the next page.', array('%url'
 *             => url('user/register')));
Dries's avatar
   
Dries committed
547
 * @endcode
548
549
550
 * We suggest the same syntax for links to other sites. This makes it easy to
 * change link URLs if needed (which happens often) without requiring updates
 * to translations.
Kjartan's avatar
Kjartan committed
551
 *
Dries's avatar
   
Dries committed
552
 * @param $string
Dries's avatar
   
Dries committed
553
 *   A string containing the English string to translate.
Dries's avatar
   
Dries committed
554
555
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
   
Dries committed
556
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
   
Dries committed
557
558
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
559
 */
Dries's avatar
   
Dries committed
560
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
561
562
563
564
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
565

Dries's avatar
   
Dries committed
566
567
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
568
569
  }
  else {
Dries's avatar
   
Dries committed
570
571
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
572
573
}

Kjartan's avatar
Kjartan committed
574
/**
Dries's avatar
   
Dries committed
575
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
576
 * @{
Dries's avatar
   
Dries committed
577
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
578
579
 */

580
/**
Dries's avatar
   
Dries committed
581
582
583
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
584
 *
Dries's avatar
   
Dries committed
585
 * @param $mail
586
 *   A string containing an e-mail address.
Dries's avatar
   
Dries committed
587
 * @return
Dries's avatar
   
Dries committed
588
 *   TRUE if the address is in a valid format.
589
 */
Dries's avatar
   
Dries committed
590
function valid_email_address($mail) {
591
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
592
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
593
594
595
  $ipv4 = '[0-9]{1,3}(\.[0-9]{1,3}){3}';
  $ipv6 = '[0-9a-fA-F]{1,4}(\:[0-9a-fA-F]{1,4}){7}';

Dries's avatar
Dries committed
596
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
597
598
}

Dries's avatar
   
Dries committed
599
600
601
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
602
 * @param $url
Dries's avatar
   
Dries committed
603
 *   The URL to verify.
Dries's avatar
   
Dries committed
604
 * @param $absolute
Dries's avatar
   
Dries committed
605
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
   
Dries committed
606
 * @return
Dries's avatar
   
Dries committed
607
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
608
 */
Dries's avatar
   
Dries committed
609
function valid_url($url, $absolute = FALSE) {
610
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
611
  if ($absolute) {
612
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
613
614
  }
  else {
615
    return preg_match("/^". $allowed_characters ."+$/i", $url);
616
  }
Dries's avatar
   
Dries committed
617
618
}

Dries's avatar
   
Dries committed
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
/**
 * Register an event for the current visitor (hostname/IP) to the flood control mechanism.
 *
 * @param $name
 *   The name of the event.
 */
function flood_register_event($name) {
  db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, $_SERVER['REMOTE_ADDR'], time());
}

/**
 * Check if the current visitor (hostname/IP) is allowed to proceed with the specified event.
 * The user is allowed to proceed if he did not trigger the specified event more than
 * $threshold times per hour.
 *
 * @param $name
 *   The name of the event.
 * @param $number
 *   The maximum number of the specified event per hour (per visitor).
 * @return
 *   True if the user did not exceed the hourly threshold.  False otherwise.
 */
function flood_is_allowed($name, $threshold) {
  $number = db_num_rows(db_query("SELECT event FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, $_SERVER['REMOTE_ADDR'], time() - 3600));
  return ($number < $threshold ? TRUE : FALSE);
}

646
647
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
648
649
}

Dries's avatar
Dries committed
650
651
652
653
654
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
655
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
656
657
}

Dries's avatar
   
Dries committed
658
/**
Dries's avatar
   
Dries committed
659
 * @defgroup format Formatting
Dries's avatar
   
Dries committed
660
 * @{
Dries's avatar
   
Dries committed
661
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
   
Dries committed
662
663
 */

Dries's avatar
   
Dries committed
664
665
666
667
668
669
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
function format_rss_channel($title, $link, $description, $items, $language = 'en', $args = array()) {
Dries's avatar
   
Dries committed
670
671
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
672
  $output = "<channel>\n";
673
674
675
676
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
  $output .= ' <language>'. check_plain($language) ."</language>\n";
Dries's avatar
   
Dries committed
677
  foreach ($args as $key => $value) {
678
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
   
Dries committed
679
  }
Dries's avatar
   
Dries committed
680
681
682
683
684
685
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
   
Dries committed
686
687
688
689
690
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
   
Dries committed
691
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
692
  $output = "<item>\n";
693
694
695
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
Dries's avatar
   
Dries committed
696
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
697
698
699
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
700
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
   
Dries committed
701
702
703
704
705
706
707
708
709
710
711
712
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
713
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
   
Dries committed
714
    }
Dries's avatar
   
Dries committed
715
  }
Dries's avatar
   
Dries committed
716
717
718
719
720
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
721
/**
Dries's avatar
   
Dries committed
722
 * Format a string containing a count of items.
Dries's avatar
   
Dries committed
723
 *
Dries's avatar
   
Dries committed
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 * This function ensures that the string is pluralized correctly. Since t() is
 * called by this function, make sure not to pass already-localized strings to it.
 *
 * @param $count
 *   The item count to display.
 * @param $singular
 *   The string for the singular case. Please make sure it is clear this is
 *   singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
 *   to ease translation. Use %count in place of the item count, as in "%count
 *   new comments".
 * @return
 *   A translated string.
Dries's avatar
   
Dries committed
738
 */
Dries's avatar
   
Dries committed
739
function format_plural($count, $singular, $plural) {
740
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
   
Dries committed
741
742

  // get the plural index through the gettext formula
743
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
   
Dries committed
744
745
746
747
748
749
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
750
        return t($singular, array("%count" => $count));
Dries's avatar
   
Dries committed
751
752
753
754
755
756
      case "1":
        return t($plural, array("%count" => $count));
      default:
        return t(strtr($plural, array("%count" => '%count['. $index .']')), array('%count['. $index .']' => $count));
    }
  }
Dries's avatar
   
Dries committed
757
758
}

Dries's avatar
   
Dries committed
759
/**
Dries's avatar
   
Dries committed
760
 * Generate a string representation for the given byte count.
Dries's avatar
   
Dries committed
761
 *
Dries's avatar
   
Dries committed
762
763
764
765
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
   
Dries committed
766
 */
Dries's avatar
   
Dries committed
767
function format_size($size) {
Dries's avatar
   
Dries committed
768
  $suffix = t('bytes');
769
  if ($size >= 1024) {
Dries's avatar
   
Dries committed
770
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
771
    $suffix = t('KB');
Dries's avatar
   
Dries committed
772
  }
773
  if ($size >= 1024) {
Dries's avatar
   
Dries committed
774
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
775
    $suffix = t('MB');
Dries's avatar
   
Dries committed
776
  }
Dries's avatar
   
Dries committed
777
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
   
Dries committed
778
779
}

Dries's avatar
   
Dries committed
780
/**
Dries's avatar
   
Dries committed
781
 * Format a time interval with the requested granularity.
Dries's avatar
   
Dries committed
782
 *
Dries's avatar
   
Dries committed
783
784
785
786
787
788
 * @param $timestamp
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
 * @return
 *   A translated string representation of the interval.
Dries's avatar
   
Dries committed
789
 */
Dries's avatar
   
Dries committed
790
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
   
Dries committed
791
  $units = array('1 year|%count years' => 31536000, '1 week|%count weeks' => 604800, '1 day|%count days' => 86400, '1 hour|%count hours' => 3600, '1 min|%count min' => 60, '1 sec|%count sec' => 1);
Dries's avatar
   
Dries committed
792
  $output = '';
Dries's avatar
   
Dries committed
793
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
794
    $key = explode('|', $key);
Dries's avatar
   
Dries committed
795
    if ($timestamp >= $value) {
Dries's avatar
   
Dries committed
796
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
   
Dries committed
797
      $timestamp %= $value;
Dries's avatar
   
Dries committed
798
799
800
801
802
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
803
804
    }
  }
Dries's avatar
   
Dries committed
805
  return $output ? $output : t('0 sec');
Dries's avatar
   
Dries committed
806
807
}

Dries's avatar
   
Dries committed
808
/**
Dries's avatar
   
Dries committed
809
810
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
   
Dries committed
811
812
813
814
 * Drupal allows administrators to select formatting strings for 'small',
 * 'medium' and 'large' date formats. This function can handle these formats,
 * as well as any custom format.
 *
Dries's avatar
   
Dries committed
815
816
817
818
819
820
 * @param $timestamp
 *   The exact date to format, as a UNIX timestamp.
 * @param $type
 *   The format to use. Can be "small", "medium" or "large" for the preconfigured
 *   date formats. If "custom" is specified, then $format is required as well.
 * @param $format
821
822
823
 *   A PHP date format string as required by date(). A backslash should be used
 *   before a character to avoid interpreting the character as part of a date
 *   format.
Dries's avatar
   
Dries committed
824
825
826
827
 * @param $timezone
 *   Time zone offset in seconds; if omitted, the user's time zone is used.
 * @return
 *   A translated date string in the requested format.
Dries's avatar
   
Dries committed
828
 */
829
830
831
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
832
833
834
835
836
837
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
838
  }
Dries's avatar
   
Dries committed
839

840
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
841
842

  switch ($type) {
843
844
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
845
      break;
846
847
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
848
      break;
849
    case 'custom':
Dries's avatar
   
Dries committed
850
      // No change to format
Dries's avatar
   
Dries committed
851
      break;
852
    case 'medium':
Dries's avatar
   
Dries committed
853
    default:
854
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
855
856
  }

857
  $max = strlen($format);
Dries's avatar
   
Dries committed
858
  $date = '';
Dries's avatar
   
Dries committed
859
  for ($i = 0; $i < $max; $i++) {
860
    $c = $format[$i];
861
    if (strpos('AaDFlM', $c) !== false) {
862
      $date .= t(gmdate($c, $timestamp));
863
    }
864
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
865
866
867
868
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries's avatar
   
Dries committed
869
    }
870
871
872
873
874
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
Dries's avatar
   
Dries committed
875
    }
876
877
878
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
   
Dries committed
879
    else {
880
      $date .= $c;
Dries's avatar
   
Dries committed
881
    }
Dries's avatar
   
Dries committed
882
  }
883

Dries's avatar
   
Dries committed
884
885
886
  return $date;
}

Dries's avatar
   
Dries committed
887
888
889
/**
 * @} End of "defgroup format".
 */
Dries's avatar
   
Dries committed
890

Dries's avatar
   
Dries committed
891
/**
892
 * Generate a URL from a Drupal menu path. Will also pass-through existing URLs.
Dries's avatar
   
Dries committed
893
894
 *
 * @param $path
895
896
 *   The Drupal path being linked to, such as "admin/node", or an existing URL
 *   like "http://drupal.org/".
Dries's avatar
   
Dries committed
897
 * @param $query
898
 *   A query string to append to the link or URL.
Dries's avatar
   
Dries committed
899
 * @param $fragment
900
901
902
 *   A fragment identifier (named anchor) to append to the link. If an existing
 *   URL with a fragment identifier is used, it will be replaced. Note, do not
 *   include the '#'.
Dries's avatar
   
Dries committed
903
904
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
905
906
 *   Useful for links that will be displayed outside the site, such as in an
 *   RSS feed.
Dries's avatar
   
Dries committed
907
908
909
910
911
912
913
 * @return
 *   an HTML string containing a link to the given path.
 *
 * When creating links in modules, consider whether l() could be a better
 * alternative than url().
 */
function url($path = NULL, $query = NULL, $fragment = NULL, $absolute = FALSE) {
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
  if (isset($fragment)) {
    $fragment = '#'. $fragment;
  }

  // Return an external link if $path contains an allowed absolute URL.
  // Only call the slow filter_xss_bad_protocol if $path contains a ':'.
  if (strpos($path, ':') !== FALSE && filter_xss_bad_protocol($path) == $path) {
    // Split off the fragment
    if (strpos($path, '#')) {
      list($path, $old_fragment) = explode('#', $path, 2);
      if (isset($old_fragment) && !isset($fragment)) {
        $fragment = '#'. $old_fragment;
      }
    }
    // Append the query
    if (isset($query)) {
      $path .= (strpos($path, '?') ? '&' : '?') . $query;
    }
    // Reassemble
    return $path . $fragment;
  }
Dries's avatar
   
Dries committed
935

936
  global $base_url;
Dries's avatar
   
Dries committed
937
  static $script;
938
  static $clean_url;
Dries's avatar
   
Dries committed
939
940

  if (empty($script)) {
Dries's avatar
   
Dries committed
941
942
943
    // On some web servers, such as IIS, we can't omit "index.php".  So, we
    // generate "index.php?q=foo" instead of "?q=foo" on anything that is not
    // Apache.
Dries's avatar
   
Dries committed
944
    $script = (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') === false) ? 'index.php' : '';
Dries's avatar
   
Dries committed
945
  }
946

947
948
949
950
  // Cache the clean_url variable to improve performance.
  if ($clean_url === NULL) {
    $clean_url = (variable_get('clean_url', '0') == '0') ? false : true;
  }
Dries's avatar
   
Dries committed
951

952
  $base = ($absolute ? $base_url .'/' : '');
Dries's avatar
Dries committed
953

954
955
956
957
958
  // The special path '<front>' links to the default front page.
  if (isset($path) && $path != '<front>') {
    $path = drupal_get_path_alias($path);
    $path = drupal_urlencode($path);
    if (!$clean_url) {
Dries's avatar
   
Dries committed
959
      if (isset($query)) {
960
        return $base . $script .'?q='. $path .'&'. $query . $fragment;
Dries's avatar
   
Dries committed
961
962
      }
      else {
Dries's avatar
   
Dries committed
963
        return $base . $script .'?q='. $path . $fragment;
Dries's avatar
   
Dries committed
964
      }
Dries's avatar
   
Dries committed
965
966
    }
    else {
Dries's avatar
   
Dries committed
967
      if (isset($query)) {
968
        return $base . $path .'?'. $query . $fragment;
Dries's avatar
   
Dries committed
969
970
      }
      else {
971
        return $base . $path . $fragment;
Dries's avatar
   
Dries committed
972
      }
Dries's avatar
   
Dries committed
973
974
975
    }
  }
  else {
976
977
    if (isset($query)) {
      return $base . $script .'?'. $query . $fragment;
Dries's avatar
   
Dries committed
978
    }
Dries's avatar
   
Dries committed
979
    else {
980
      return $base . $fragment;
Dries's avatar
   
Dries committed
981
    }
Dries's avatar
   
Dries committed
982
  }
Dries's avatar
   
Dries committed
983
984
}

Dries's avatar
   
Dries committed
985
986
987
988
989
990
991
992
/**
 * Format an attribute string to insert in a tag.
 *
 * @param $attributes
 *   An associative array of HTML attributes.
 * @return
 *   An HTML string ready for insertion in a tag.
 */
993
function drupal_attributes($attributes = array()) {
994
  if (is_array($attributes)) {
995
996
    $t = array();
    foreach ($attributes as $key => $value) {
997
      $t[] = $key .'="'. check_plain($value) .'"';
998
    }
999
    return ' '. implode(' ', $t);
Dries's avatar
   
Dries committed
1000
  }
1001
}
Dries's avatar
   
Dries committed
1002

Dries's avatar
   
Dries committed
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
/**
 * Format an internal Drupal link.
 *
 * This function correctly handles aliased paths, and allows themes to highlight
 * links to the current page correctly, so all internal links output by modules
 * should be generated by this function if possible.
 *
 * @param $text
 *   The text to be enclosed with the anchor tag.
 * @param $path
1013
1014
 *   The Drupal path being linked to, such as "admin/node". Note, this must be a
 *   system URL as the url() function will generate the alias.
Dries's avatar
   
Dries committed
1015
1016
1017
1018
1019
1020
1021
1022
1023
 * @param $attributes
 *   An associative array of HTML attributes to apply to the anchor tag.
 * @param $query
 *   A query string to append to the link.
 * @param $fragment
 *   A fragment identifier (named anchor) to append to the link.
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
 *   Useful for links that will be displayed outside the site, such as in an RSS feed.
1024
1025
 * @param $html
 *   Whether the title is HTML, or just plain-text.
Dries's avatar
   
Dries committed
1026
1027
1028
 * @return
 *   an HTML string containing a link to the given path.
 */
1029
function l($text, $path, $attributes = array(), $query = NULL, $fragment = NULL, $absolute = FALSE, $html = FALSE) {
1030
  if ($path == $_GET['q']) {
Dries's avatar
   
Dries committed
1031
1032
1033
1034
1035
1036
1037
    if (isset($attributes['class'])) {
      $attributes['class'] .= ' active';
    }
    else {
      $attributes['class'] = 'active';
    }
  }
1038
  return '<a href="'. check_url(url($path, $query, $fragment, $absolute)) .'"'. drupal_attributes($attributes) .'>'. ($html ? $text : check_plain($text)) .'</a>';
Dries's avatar
   
Dries committed
1039
1040
}

Dries's avatar
   
Dries committed
1041
1042
1043
1044
1045
1046
/**
 * Perform end-of-request tasks.
 *
 * This function sets the page cache if appropriate, and allows modules to
 * react to the closing of the page by calling hook_exit().
 */
Dries's avatar
   
Dries committed
1047
function drupal_page_footer() {
Dries's avatar
   
Dries committed
1048
  if (variable_get('cache', 0)) {
Dries's avatar
   
Dries committed
1049
    page_set_cache();
Dries's avatar
   
Dries committed
1050
  }
Dries's avatar
   
Dries committed
1051

Dries's avatar
   
Dries committed
1052
  module_invoke_all('exit');
Dries's avatar
   
Dries committed
1053
1054
}

Dries's avatar
   
Dries committed
1055
/**
Dries's avatar
   
Dries committed
1056
 * Form an associative array from a linear array.
Dries's avatar
   
Dries committed