common.inc 56.5 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
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
36
function drupal_set_content($region = NULL, $data = NULL) {
37
38
39
40
41
42
43
44
45
46
47
48
  static $content = array();

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

/**
 * Get assigned content.
 *
 * @param $region
49
 *   A specified region to fetch content for. If NULL, all regions will be returned.
50
51
52
53
 *
 * @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
function drupal_get_html_head() {
Dries's avatar
   
Dries committed
117
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
118
119
120
  return $output . drupal_set_html_head();
}

Dries's avatar
   
Dries committed
121
/**
122
 * Reset the static variable which holds the aliases mapped for this request.
Dries's avatar
   
Dries committed
123
 */
124
125
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries's avatar
   
Dries committed
126
}
Kjartan's avatar
Kjartan committed
127

Dries's avatar
Dries committed
128
/**
Dries's avatar
   
Dries committed
129
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
130
131
 */
function drupal_set_header($header = NULL) {
132
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
   
Dries committed
133
  // Otherwise, header('') could get called when serving the page later, which
134
135
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
136

137
  if (strlen($header)) {
Dries's avatar
Dries committed
138
    header($header);
139
    $stored_headers[] = $header;
Dries's avatar
Dries committed
140
  }
141
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
142
143
}

Dries's avatar
   
Dries committed
144
145
146
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
147
148
149
150
function drupal_get_headers() {
  return drupal_set_header();
}

151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
 * Add a feed URL for the current page.
 *
 * @param $url
 *   The url for the feed
 * @param $theme_function
 *   The name of the theming function to use to style the feed icon, defaults to theme_feed_icon()
 */
function drupal_add_feed($url = NULL, $theme_function = 'feed_icon') {
  static $stored_feed_links = array();

  if (!is_null($url)) {
    $stored_feed_links[$url] = theme($theme_function, $url);
  }
  return $stored_feed_links;
}

/**
 * Get the feed URLs for the current page.
 *
 * @param $delimiter
 *   The delimiter to split feeds by
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
   
Dries committed
179
180
181
/**
 * @name HTTP handling
 * @{
Dries's avatar
   
Dries committed
182
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
183
184
 */

185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/**
 * Parse an array into a valid urlencoded query string.
 *
 * @param $query
 *   The array to be processed e.g. $_GET
 * @param $exclude
 *   The array filled with keys to be excluded. Use parent[child] to exclude nested items.
 * @param $urlencode
 *   If TRUE, the keys and values are both urlencoded.
 * @param $parent
 *   Should not be passed, only used in recursive calls
 * @return
 *   urlencoded string which can be appended to/as the URL query string
 */
function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
  $params = array();

  foreach ($query as $key => $value) {
203
    $key = drupal_urlencode($key);
204
    if ($parent) {
205
      $key = $parent .'['. $key .']';
206
207
    }

208
    if (in_array($key, $exclude)) {
209
210
211
212
213
214
215
      continue;
    }

    if (is_array($value)) {
      $params[] = drupal_query_string_encode($value, $exclude, $key);
    }
    else {
216
      $params[] = $key .'='. drupal_urlencode($value);
217
218
219
220
221
222
    }
  }

  return implode('&', $params);
}

223
224
/**
 * Prepare a destination query string for use in combination with
225
226
227
 * 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
228
 * is returned. As such, a destination can persist across multiple
229
 * pages.
230
231
232
233
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
234
  if (isset($_REQUEST['destination'])) {
235
236
237
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
238
    // Use $_REQUEST here to retrieve the original path.
239
    $path = isset($_REQUEST['q']) ? drupal_get_path_alias($_REQUEST['q']) : '';
240
241
242
    $query = drupal_query_string_encode($_GET, array('q'));
    if ($query != '') {
      $path .= '?'. $query;
243
    }
244
    return 'destination='. urlencode($path);
245
246
247
  }
}

Kjartan's avatar
Kjartan committed
248
/**
Dries's avatar
   
Dries committed
249
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
250
 *
Dries's avatar
   
Dries committed
251
252
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
253
 *
254
 * Usually the redirected URL is constructed from this function's input
255
 * parameters. However you may override that behavior by setting a
256
257
 * <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
258
259
 * 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
260
 * a post on the 'admin/content/node'-page or after having logged on using the
261
 * 'user login'-block in a sidebar. The function drupal_get_destination()
262
263
 * can be used to help set the destination URL.
 *
Dries's avatar
   
Dries committed
264
265
266
267
268
269
270
271
272
273
274
275
276
 * 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).
277
278
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
279
 */
Dries's avatar
   
Dries committed
280
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
281
  if (isset($_REQUEST['destination'])) {
282
283
    extract(parse_url($_REQUEST['destination']));
  }
284
  else if (isset($_REQUEST['edit']['destination'])) {
285
286
287
    extract(parse_url($_REQUEST['edit']['destination']));
  }

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

Dries's avatar
   
Dries committed
290
291
292
293
  // 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
294

Dries's avatar
   
Dries committed
295
296
297
  // 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
298
299
300
  exit();
}

301
/**
302
 * Generates a site off-line message
303
304
 */
function drupal_site_offline() {
305
  drupal_set_header('HTTP/1.0 503 Service unavailable');
306
  drupal_set_title(t('Site off-line'));
307
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
308
    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')))))));
309
310
}

Kjartan's avatar
Kjartan committed
311
312
313
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
314
function drupal_not_found() {
315
  drupal_set_header('HTTP/1.0 404 Not Found');
316
  watchdog('page not found', t('%page not found.', array('%page' => $_GET['q'])), WATCHDOG_WARNING);
Dries's avatar
   
Dries committed
317

318
319
320
321
322
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
   
Dries committed
323
  $path = drupal_get_normal_path(variable_get('site_404', ''));
324
  if ($path && $path != $_GET['q']) {
Dries's avatar
   
Dries committed
325
    menu_set_active_item($path);
326
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
327
  }
328
  else {
329
    // Redirect to a non-existent menu item to make possible tabs disappear.
330
    menu_set_active_item('');
331
  }
Dries's avatar
   
Dries committed
332

333
  if (empty($return)) {
334
    drupal_set_title(t('Page not found'));
Dries's avatar
   
Dries committed
335
  }
336
  print theme('page', $return);
Dries's avatar
   
Dries committed
337
}
Dries's avatar
   
Dries committed
338

Dries's avatar
   
Dries committed
339
340
341
342
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
343
  drupal_set_header('HTTP/1.0 403 Forbidden');
344
  watchdog('access denied', t('%page denied access.', array('%page' => $_GET['q'])), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries's avatar
   
Dries committed
345

346
347
348
349
350
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
   
Dries committed
351
  $path = drupal_get_normal_path(variable_get('site_403', ''));
352
  if ($path && $path != $_GET['q']) {
Dries's avatar
   
Dries committed
353
    menu_set_active_item($path);
354
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
355
  }
356
  else {
357
    // Redirect to a non-existent menu item to make possible tabs disappear.
358
    menu_set_active_item('');
359
  }
Dries's avatar
   
Dries committed
360

361
  if (empty($return)) {
362
    drupal_set_title(t('Access denied'));
363
    $return = t('You are not authorized to access this page.');
Dries's avatar
   
Dries committed
364
  }
365
  print theme('page', $return);
Dries's avatar
   
Dries committed
366
367
}

Dries's avatar
   
Dries committed
368
/**
Dries's avatar
   
Dries committed
369
 * Perform an HTTP request.
Dries's avatar
   
Dries committed
370
 *
Dries's avatar
   
Dries committed
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 * 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
388
389
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
   
Dries committed
390
391
  $result = new StdClass();

Dries's avatar
   
Dries committed
392
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
   
Dries committed
393
394
395
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
396
      $port = isset($uri['port']) ? $uri['port'] : 80;
397
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
398
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries's avatar
   
Dries committed
399
400
      break;
    case 'https':
Dries's avatar
   
Dries committed
401
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
Dries's avatar
Dries committed
402
      $port = isset($uri['port']) ? $uri['port'] : 443;
403
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
404
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries's avatar
   
Dries committed
405
406
      break;
    default:
Dries's avatar
   
Dries committed
407
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
   
Dries committed
408
409
410
      return $result;
  }

Dries's avatar
   
Dries committed
411
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
412
  if (!$fp) {
Dries's avatar
   
Dries committed
413
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
   
Dries committed
414
415
416
    return $result;
  }

Dries's avatar
   
Dries committed
417
  // Construct the path to act on.
Dries's avatar
Dries committed
418
419
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
   
Dries committed
420
    $path .= '?'. $uri['query'];
Dries's avatar
   
Dries committed
421
422
  }

Dries's avatar
   
Dries committed
423
  // Create HTTP request.
Dries's avatar
   
Dries committed
424
  $defaults = array(
425
426
427
428
    // RFC 2616: "non-standard ports MUST, default ports MAY be included".
    // We don't add the port to prevent from breaking rewrite rules checking
    // the host that do not take into account the port number.
    'Host' => "Host: $host",
429
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
430
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
431
432
433
  );

  foreach ($headers as $header => $value) {
Dries's avatar
   
Dries committed
434
    $defaults[$header] = $header .': '. $value;
Dries's avatar
   
Dries committed
435
436
  }

Dries's avatar
   
Dries committed
437
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
   
Dries committed
438
439
440
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
   
Dries committed
441
    $request .= $data ."\r\n";
Dries's avatar
   
Dries committed
442
443
444
445
446
447
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
448
  $response = '';
449
450
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
   
Dries committed
451
452
453
454
  }
  fclose($fp);

  // Parse response.
455
456
  list($split, $result->data) = explode("\r\n\r\n", $response, 2);
  $split = preg_split("/\r\n|\n|\r/", $split);
457

458
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
   
Dries committed
459
460
461
  $result->headers = array();

  // Parse headers.
462
  while ($line = trim(array_shift($split))) {
Dries's avatar
   
Dries committed
463
    list($header, $value) = explode(':', $line, 2);
464
465
466
467
468
469
470
471
    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
472
473
474
475
476
477
478
479
480
481
  }

  $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
482
  // the base code in their class.
Dries's avatar
   
Dries committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
  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
510
511
512
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
513

Dries's avatar
   
Dries committed
514
/**
Dries's avatar
   
Dries committed
515
516
 * Log errors as defined by administrator
 * Error levels:
517
518
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries's avatar
   
Dries committed
519
 */
Dries's avatar
   
Dries committed
520
function error_handler($errno, $message, $filename, $line) {
521
522
523
524
525
  // If the @ error suppression operator was used, error_reporting is temporarily set to 0
  if (error_reporting() == 0) {
    return;
  }

526
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
   
Dries committed
527
528
    $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
529

530
    // Force display of error messages in update.php
531
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['PHP_SELF'], 'update.php')) {
532
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
533
    }
534
535

    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
536
537
538
  }
}

Dries's avatar
   
Dries committed
539
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
540
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
541
542
543
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
544
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
545
546
547
  }
}

Dries's avatar
   
Dries committed
548
549
550
551
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
   
Dries committed
552
function fix_gpc_magic() {
553
  static $fixed = FALSE;
Dries's avatar
   
Dries committed
554
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
555
556
557
558
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
559
    $fixed = TRUE;
Dries's avatar
Dries committed
560
  }
Dries's avatar
   
Dries committed
561
562
}

Dries's avatar
   
Dries committed
563
564
565
/**
 * Initialize the localization system.
 */
Dries's avatar
   
Dries committed
566
567
function locale_initialize() {
  global $user;
Dries's avatar
   
Dries committed
568
569
570
571
572

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

Dries's avatar
   
Dries committed
573
574
575
576
577
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
578
579
580
    // 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
581
  }
582
  if ($user->uid && isset($languages[$user->language])) {
Dries's avatar
   
Dries committed
583
584
585
586
587
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
588
589
}

Kjartan's avatar
Kjartan committed
590
/**
Dries's avatar
   
Dries committed
591
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
592
 *
593
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
   
Dries committed
594
595
596
597
 * 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
598
599
 *   $msg = t('You must log in below or <a href="@url">create a new
 *             account</a> before viewing the next page.', array('@url'
Dries's avatar
   
Dries committed
600
 *             => url('user/register')));
Dries's avatar
   
Dries committed
601
 * @endcode
602
603
604
 * 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
605
 *
Dries's avatar
   
Dries committed
606
 * @param $string
Dries's avatar
   
Dries committed
607
 *   A string containing the English string to translate.
Dries's avatar
   
Dries committed
608
609
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
   
Dries committed
610
 *   of any key in this array are replaced with the corresponding value.
611
612
613
614
615
 *   Based on the first character of the key, the value is escaped and/or themed:
 *    - !variable: inserted as is
 *    - @variable: escape plain text to HTML (check_plain)
 *    - %variable: escape text and theme as a placeholder for user-submitted
 *      content (check_plain + theme_placeholder)
Dries's avatar
   
Dries committed
616
617
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
618
 */
Dries's avatar
   
Dries committed
619
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
620
621
622
623
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
Dries's avatar
   
Dries committed
624
625
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
626
627
  }
  else {
628
629
    // Transform arguments before inserting them
    array_walk($args, '_t');
Dries's avatar
   
Dries committed
630
631
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
632
633
}

634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
/**
 * Helper function: apply the appropriate transformation to st() and t()
 * placeholders.
 */
function _t(&$value, $key) {
  switch ($key[0]) {
    // Escaped only
    case '@':
      $value = check_plain($value);
      return;
    // Escaped and placeholder
    case '%':
    default:
      $value = theme('placeholder', $value);
      return;
Steven Wittens's avatar
Steven Wittens committed
649
650
    // Pass-through
    case '!':
651
652
653
  }
}

Kjartan's avatar
Kjartan committed
654
/**
Dries's avatar
   
Dries committed
655
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
656
 * @{
Dries's avatar
   
Dries committed
657
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
658
659
 */

660
/**
Dries's avatar
   
Dries committed
661
662
663
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
664
 *
Dries's avatar
   
Dries committed
665
 * @param $mail
666
 *   A string containing an e-mail address.
Dries's avatar
   
Dries committed
667
 * @return
Dries's avatar
   
Dries committed
668
 *   TRUE if the address is in a valid format.
669
 */
Dries's avatar
   
Dries committed
670
function valid_email_address($mail) {
671
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
672
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
673
674
675
  $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
676
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
677
678
}

Dries's avatar
   
Dries committed
679
680
681
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
682
 * @param $url
Dries's avatar
   
Dries committed
683
 *   The URL to verify.
Dries's avatar
   
Dries committed
684
 * @param $absolute
Dries's avatar
   
Dries committed
685
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
   
Dries committed
686
 * @return
Dries's avatar
   
Dries committed
687
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
688
 */
Dries's avatar
   
Dries committed
689
function valid_url($url, $absolute = FALSE) {
690
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
691
  if ($absolute) {
692
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
693
694
  }
  else {
695
    return preg_match("/^". $allowed_characters ."+$/i", $url);
696
  }
Dries's avatar
   
Dries committed
697
698
}

Dries's avatar
   
Dries committed
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
/**
 * 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
719
 *   True if the user did not exceed the hourly threshold. False otherwise.
Dries's avatar
   
Dries committed
720
721
722
723
724
725
 */
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);
}

726
727
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
728
729
}

Dries's avatar
Dries committed
730
731
732
733
734
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
735
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
736
737
}

Dries's avatar
   
Dries committed
738
/**
Dries's avatar
   
Dries committed
739
 * @defgroup format Formatting
Dries's avatar
   
Dries committed
740
 * @{
Dries's avatar
   
Dries committed
741
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
   
Dries committed
742
743
 */

Dries's avatar
   
Dries committed
744
745
746
747
748
749
/**
 * 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
750
751
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
752
  $output = "<channel>\n";
753
754
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
755
756
757
758
759

  // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
  // We strip all HTML tags, but need to prevent double encoding from properly
  // escaped source data (such as &amp becoming &amp;amp;).
  $output .= ' <description>'. check_plain(decode_entities(strip_tags($description))) ."</description>\n";
760
  $output .= ' <language>'. check_plain($language) ."</language>\n";
761
  $output .= format_xml_elements($args);
Dries's avatar
   
Dries committed
762
763
764
765
766
767
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
   
Dries committed
768
769
770
771
772
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
   
Dries committed
773
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
774
  $output = "<item>\n";
775
776
777
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
 * Format XML elements.
 *
 * @param $array
 *   An array where each item represent an element and is either a:
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
 *     - 'key': element name
 *     - 'value': element contents
 *     - 'attributes': associative array of element attributes
 *
 * In both cases, 'value' can be a simple string, or it can be another array
 * with the same format as $array itself for nesting.
 */
function format_xml_elements($array) {
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
   
Dries committed
801
802
      if ($value['key']) {
        $output .= ' <'. $value['key'];
803
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
   
Dries committed
804
805
806
          $output .= drupal_attributes($value['attributes']);
        }

807
808
        if ($value['value'] != '') {
          $output .= '>'. (is_array($value['value']) ? format_xml_tags($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
Dries's avatar
   
Dries committed
809
810
811
812
813
814
815
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
816
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_tags($value) : check_plain($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
817
    }
Dries's avatar
   
Dries committed
818
  }
Dries's avatar
   
Dries committed
819
820
821
  return $output;
}

Dries's avatar
   
Dries committed
822
/**
Dries's avatar
   
Dries committed
823
 * Format a string containing a count of items.
Dries's avatar
   
Dries committed
824
 *
Dries's avatar
   
Dries committed
825
826
827
828
829
830
831
832
833
834
 * 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,
835
 *   to ease translation. Use @count in place of the item count, as in "@count
Dries's avatar
   
Dries committed
836
837
838
 *   new comments".
 * @return
 *   A translated string.
Dries's avatar
   
Dries committed
839
 */
Dries's avatar
   
Dries committed
840
function format_plural($count, $singular, $plural) {
841
  if ($count == 1) return t($singular, array("@count" => $count));
Dries's avatar
   
Dries committed
842
843

  // get the plural index through the gettext formula
844
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
   
Dries committed
845
  if ($index < 0) { // backward compatibility
846
    return t($plural, array("@count" => $count));
Dries's avatar
   
Dries committed
847
848
849
850
  }
  else {
    switch ($index) {
      case "0":
851
        return t($singular, array("@count" => $count));
Dries's avatar
   
Dries committed
852
      case "1":
853
        return t($plural, array("@count" => $count));
Dries's avatar
   
Dries committed
854
      default:
855
        return t(strtr($plural, array("@count" => '@count['. $index .']')), array('@count['. $index .']' => $count));
Dries's avatar
   
Dries committed
856
857
    }
  }
Dries's avatar
   
Dries committed
858
859
}

Dries's avatar
   
Dries committed
860
/**
Dries's avatar
   
Dries committed
861
 * Generate a string representation for the given byte count.
Dries's avatar
   
Dries committed
862
 *
Dries's avatar
   
Dries committed
863
864
865
866
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
   
Dries committed
867
 */
Dries's avatar
   
Dries committed
868
function format_size($size) {
Dries's avatar
   
Dries committed
869
  $suffix = t('bytes');
870
  if ($size >= 1024) {
Dries's avatar
   
Dries committed
871
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
872
    $suffix = t('KB');
Dries's avatar
   
Dries committed
873
  }
874
  if ($size >= 1024) {
Dries's avatar
   
Dries committed
875
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
876
    $suffix = t('MB');
Dries's avatar
   
Dries committed
877
  }
878
  return t('@size @suffix', array('@size' => $size, '@suffix' => $suffix));
Dries's avatar
   
Dries committed
879
880
}

Dries's avatar
   
Dries committed
881
/**
Dries's avatar
   
Dries committed
882
 * Format a time interval with the requested granularity.
Dries's avatar
   
Dries committed
883
 *
Dries's avatar
   
Dries committed
884
885
886
887
888
889
 * @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
890
 */
Dries's avatar
   
Dries committed
891
function format_interval($timestamp, $granularity = 2) {
892
  $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
893
  $output = '';
Dries's avatar
   
Dries committed
894
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
895
    $key = explode('|', $key);
Dries's avatar
   
Dries committed
896
    if ($timestamp >= $value) {
Dries's avatar
   
Dries committed
897
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
   
Dries committed
898
      $timestamp %= $value;
Dries's avatar
   
Dries committed
899
900
901
902
903
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
904
905
    }
  }
Dries's avatar
   
Dries committed
906
  return $output ? $output : t('0 sec');
Dries's avatar
   
Dries committed
907
908
}

Dries's avatar
   
Dries committed
909
/**
Dries's avatar
   
Dries committed
910
911
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
   
Dries committed
912
913
914
915
 * 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
916
917
918
919
920
921
 * @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
922
923
924
 *   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
925
926
927
928
 * @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
929
 */
930
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
931
  if (!isset($timezone)) {
932
    global $user;
Steven Wittens's avatar
Steven Wittens committed
933
934
935
936
937
938
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
939
  }
Dries's avatar
   
Dries committed
940

941
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
942
943

  switch ($type) {
944
945
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
946
      break;
947
948
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
949
      break;
950
    case 'custom':
Dries's avatar
   
Dries committed
951
      // No change to format
Dries's avatar
   
Dries committed
952
      break;
953
    case 'medium':
Dries's avatar
   
Dries committed
954
    default:
955
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
956
957
  }

958
  $max = strlen($format);
Dries's avatar
   
Dries committed
959
  $date = '';
Dries's avatar
   
Dries committed
960
  for ($i = 0; $i < $max; $i++) {
961
    $c = $format[$i];
962
    if (strpos('AaDFlM', $c) !== FALSE) {
963
      $date .= t(gmdate($c, $timestamp));
964
    }
965
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== FALSE) {
966
967
968
969
      $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
970
    }
971
972
973
974
975
    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
976
    }
977
978
979
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
   
Dries committed
980
    else {
981
      $date .= $c;
Dries's avatar
   
Dries committed
982
    }
Dries's avatar
   
Dries committed
983
  }
984

Dries's avatar
   
Dries committed
985
986
987
  return $date;
}

Dries's avatar
   
Dries committed
988
989
990
/**
 * @} End of "defgroup format".
 */
Dries's avatar
   
Dries committed
991

Dries's avatar
   
Dries committed
992
/**
993
 * Generate a URL from a Drupal menu path. Will also pass-through existing URLs.
Dries's avatar
   
Dries committed
994
995
 *
 * @param $path
996
 *   The Drupal path being linked to, such as "admin/content/node", or an existing URL
997
 *   like "http://drupal.org/".
Dries's avatar
   
Dries committed
998
 * @param $query
999
 *   A query string to append to the link or URL.
Dries's avatar
   
Dries committed
1000
 * @param $fragment
1001
1002
1003
 *   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
1004
1005
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
1006
1007
 *   Useful for links that will be displayed outside the site, such as in an
 *   RSS feed.
Dries's avatar
   
Dries committed
1008
 * @return
1009
 *   a string containing a URL to the given path.
Dries's avatar
   
Dries committed
1010
1011
1012
1013
1014
 *
 * 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) {
1015
1016
1017
1018
1019
1020
  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 ':'.
1021
  if (strpos($path, ':') !== FALSE && filter_xss_bad_protocol($path, FALSE) == check_plain($path)) {
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
    // 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
1036

1037
  global $base_url;
Dries's avatar
   
Dries committed
1038
  static $script;