common.inc 61.6 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.
130 131 132
 *
 * Note: when sending a Content-Type header, always include a 'charset' type
 * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
Dries's avatar
Dries committed
133 134
 */
function drupal_set_header($header = NULL) {
135
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
 
Dries committed
136
  // Otherwise, header('') could get called when serving the page later, which
137 138
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
139

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

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

154 155 156 157 158
/*
 * Add a feed URL for the current page.
 *
 * @param $url
 *   The url for the feed
159 160
 * @param $title
 *   The title of the feed
161
 */
162
function drupal_add_feed($url = NULL, $title = '') {
163 164 165
  static $stored_feed_links = array();

  if (!is_null($url)) {
166 167 168 169 170 171
    $stored_feed_links[$url] = theme('feed_icon', $url);

    drupal_add_link(array('rel' => 'alternate',
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
  }
  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
187 188 189
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
190
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
191 192
 */

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
/**
 * 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) {
211
    $key = drupal_urlencode($key);
212
    if ($parent) {
213
      $key = $parent .'['. $key .']';
214 215
    }

216
    if (in_array($key, $exclude)) {
217 218 219 220 221 222 223
      continue;
    }

    if (is_array($value)) {
      $params[] = drupal_query_string_encode($value, $exclude, $key);
    }
    else {
224
      $params[] = $key .'='. drupal_urlencode($value);
225 226 227 228 229 230
    }
  }

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

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

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

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

Dries's avatar
 
Dries committed
298 299 300 301
  // 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
302

Dries's avatar
 
Dries committed
303 304 305
  // 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
306 307 308
  exit();
}

309
/**
310
 * Generates a site off-line message
311 312
 */
function drupal_site_offline() {
313
  drupal_set_header('HTTP/1.0 503 Service unavailable');
314
  drupal_set_title(t('Site off-line'));
315
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
316
    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')))))));
317 318
}

Kjartan's avatar
Kjartan committed
319 320 321
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
322
function drupal_not_found() {
323
  drupal_set_header('HTTP/1.0 404 Not Found');
324

drumm's avatar
drumm committed
325
  watchdog('page not found', check_plain($_GET['q']), WATCHDOG_WARNING);
326

327 328 329 330 331
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
 
Dries committed
332
  $path = drupal_get_normal_path(variable_get('site_404', ''));
drumm's avatar
drumm committed
333
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
334
    menu_set_active_item($path);
335
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
336
  }
337
  else {
338
    // Redirect to a non-existent menu item to make possible tabs disappear.
339
    menu_set_active_item('');
340
  }
Dries's avatar
 
Dries committed
341

drumm's avatar
drumm committed
342 343
  if (empty($return)) {
    drupal_set_title(t('Page not found'));
Dries's avatar
 
Dries committed
344
  }
345 346
  // To conserve CPU and bandwidth, omit the blocks
  print theme('page', $return, FALSE);
Dries's avatar
 
Dries committed
347
}
Dries's avatar
 
Dries committed
348

Dries's avatar
 
Dries committed
349 350 351 352
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
353
  drupal_set_header('HTTP/1.0 403 Forbidden');
354
  watchdog('access denied', check_plain($_GET['q']), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
355

drumm's avatar
drumm committed
356
// Keep old path for reference
357 358 359 360
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
 
Dries committed
361
  $path = drupal_get_normal_path(variable_get('site_403', ''));
drumm's avatar
drumm committed
362
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
363
    menu_set_active_item($path);
364
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
365
  }
366
  else {
367
    // Redirect to a non-existent menu item to make possible tabs disappear.
368
    menu_set_active_item('');
369
  }
Dries's avatar
 
Dries committed
370

drumm's avatar
drumm committed
371 372 373
  if (empty($return)) {
    drupal_set_title(t('Access denied'));
    $return = t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
374
  }
375
  print theme('page', $return);
Dries's avatar
 
Dries committed
376 377
}

Dries's avatar
 
Dries committed
378
/**
Dries's avatar
 
Dries committed
379
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
380
 *
Dries's avatar
 
Dries committed
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
 * 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
398 399
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
400 401
  $result = new StdClass();

Dries's avatar
 
Dries committed
402
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
403 404 405
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
406
      $port = isset($uri['port']) ? $uri['port'] : 80;
407
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
408
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries's avatar
 
Dries committed
409 410
      break;
    case 'https':
Dries's avatar
 
Dries committed
411
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
Dries's avatar
Dries committed
412
      $port = isset($uri['port']) ? $uri['port'] : 443;
413
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
414
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries's avatar
 
Dries committed
415 416
      break;
    default:
Dries's avatar
 
Dries committed
417
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
418 419 420
      return $result;
  }

Dries's avatar
 
Dries committed
421
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
422
  if (!$fp) {
Dries's avatar
 
Dries committed
423
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
424 425 426
    return $result;
  }

Dries's avatar
 
Dries committed
427
  // Construct the path to act on.
Dries's avatar
Dries committed
428 429
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
 
Dries committed
430
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
431 432
  }

Dries's avatar
 
Dries committed
433
  // Create HTTP request.
Dries's avatar
 
Dries committed
434
  $defaults = array(
435 436 437 438
    // 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",
439
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
440
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
441 442 443
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
444
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
445 446
  }

Dries's avatar
 
Dries committed
447
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
448 449 450
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
451
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
452 453 454 455 456 457
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
458
  $response = '';
459 460
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
 
Dries committed
461 462 463 464
  }
  fclose($fp);

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

468
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
 
Dries committed
469 470 471
  $result->headers = array();

  // Parse headers.
472
  while ($line = trim(array_shift($split))) {
Dries's avatar
 
Dries committed
473
    list($header, $value) = explode(':', $line, 2);
474 475 476 477 478 479 480 481
    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
482 483 484 485 486 487 488 489 490 491
  }

  $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
492
  // the base code in their class.
Dries's avatar
 
Dries committed
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
  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
520 521 522
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
523

Dries's avatar
 
Dries committed
524
/**
Dries's avatar
 
Dries committed
525 526
 * Log errors as defined by administrator
 * Error levels:
527 528
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries's avatar
 
Dries committed
529
 */
Dries's avatar
 
Dries committed
530
function error_handler($errno, $message, $filename, $line) {
531 532 533 534 535
  // If the @ error suppression operator was used, error_reporting is temporarily set to 0
  if (error_reporting() == 0) {
    return;
  }

536
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
 
Dries committed
537 538
    $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
539

540
    // Force display of error messages in update.php
541
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['PHP_SELF'], 'update.php')) {
542
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
543
    }
544 545

    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
546 547 548
  }
}

Dries's avatar
 
Dries committed
549
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
550
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
551 552 553
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
554
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
555 556 557
  }
}

Dries's avatar
 
Dries committed
558 559 560 561
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
562
function fix_gpc_magic() {
563
  static $fixed = FALSE;
Dries's avatar
 
Dries committed
564
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
565 566 567 568
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
569
    array_walk($_FILES, '_fix_gpc_magic');
570
    $fixed = TRUE;
Dries's avatar
Dries committed
571
  }
Dries's avatar
 
Dries committed
572 573
}

Dries's avatar
 
Dries committed
574 575 576
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
577 578
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
579 580 581 582 583

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

Dries's avatar
 
Dries committed
584 585 586 587 588
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
589 590 591
    // 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
592
  }
593
  if ($user->uid && isset($languages[$user->language])) {
Dries's avatar
 
Dries committed
594 595 596 597 598
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
599 600
}

Kjartan's avatar
Kjartan committed
601
/**
Dries's avatar
 
Dries committed
602
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
603
 *
604
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
605 606 607 608
 * 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
609 610
 *   $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
611
 *             => url('user/register')));
Dries's avatar
 
Dries committed
612
 * @endcode
613 614 615
 * 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
616
 *
Dries's avatar
 
Dries committed
617
 * @param $string
Dries's avatar
 
Dries committed
618
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
619 620
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
621
 *   of any key in this array are replaced with the corresponding value.
622 623 624 625 626
 *   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
627 628
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
629
 */
Dries's avatar
 
Dries committed
630
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
631 632 633 634
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
Dries's avatar
 
Dries committed
635 636
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
637 638
  }
  else {
639
    // Transform arguments before inserting them
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
    foreach($args as $key => $value) {
      switch ($key[0]) {
        // Escaped only
        case '@':
          $args[$key] = check_plain($value);
        break;
        // Escaped and placeholder
        case '%':
        default:
          $args[$key] = theme('placeholder', $value);
          break;
        // Pass-through
        case '!':
      }
    }
Dries's avatar
 
Dries committed
655 656
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
657 658
}

Kjartan's avatar
Kjartan committed
659
/**
Dries's avatar
 
Dries committed
660
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
661
 * @{
Dries's avatar
 
Dries committed
662
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
663 664
 */

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

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

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

731 732
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
733 734
}

Dries's avatar
Dries committed
735 736 737 738 739
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
740
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
741 742
}

Dries's avatar
 
Dries committed
743
/**
Dries's avatar
 
Dries committed
744
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
745
 * @{
Dries's avatar
 
Dries committed
746
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
747 748
 */

Dries's avatar
 
Dries committed
749 750 751 752 753 754
/**
 * 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
755 756
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
757
  $output = "<channel>\n";
758 759
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
760 761 762 763 764

  // 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";
765
  $output .= ' <language>'. check_plain($language) ."</language>\n";
766
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
767 768 769 770 771 772
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
773 774 775 776 777
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
778
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
779
  $output = "<item>\n";
780 781 782
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
  $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
806 807
      if ($value['key']) {
        $output .= ' <'. $value['key'];
808
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
 
Dries committed
809 810 811
          $output .= drupal_attributes($value['attributes']);
        }

812
        if ($value['value'] != '') {
813
          $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
Dries's avatar
 
Dries committed
814 815 816 817 818 819 820
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
821
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
822
    }
Dries's avatar
 
Dries committed
823
  }
Dries's avatar
 
Dries committed
824 825 826
  return $output;
}

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

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

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

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

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
909 910
    }
  }
Dries's avatar
 
Dries committed
911
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
912 913
}

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

946
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
947 948

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