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

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

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

81
  if (!is_null($breadcrumb)) {
82 83 84 85 86
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

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

93
  if (is_null($breadcrumb)) {
94 95 96 97 98 99
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
100
/**
101
 * Add output to the head tag of the HTML page.
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) {
105
  static $stored_head = '';
Dries's avatar
Dries committed
106 107

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

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() {
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();
}

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

Dries's avatar
Dries committed
128
/**
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.
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
}

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
/*
 * Add a feed URL for the current page.
 *
 * @param $url
 *   The url for the feed
156 157
 * @param $title
 *   The title of the feed
158
 */
159
function drupal_add_feed($url = NULL, $title = '') {
160 161 162
  static $stored_feed_links = array();

  if (!is_null($url)) {
163 164 165 166 167 168
    $stored_feed_links[$url] = theme('feed_icon', $url);

    drupal_add_link(array('rel' => 'alternate',
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
  }
  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);
}

184 185 186
/**
 * @name HTTP handling
 * @{
187
 * Functions to properly handle HTTP responses.
188 189
 */

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

213
    if (in_array($key, $exclude)) {
214 215 216 217 218 219 220
      continue;
    }

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

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

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

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

293
  $url = url($path, $query, $fragment, TRUE);
294

295 296 297 298
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

  header('Location: '. $url);
299

300 301 302
  // 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.
303 304 305
  exit();
}

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

316 317 318
/**
 * Generates a 404 error if the request can not be handled.
 */
319
function drupal_not_found() {
320
  drupal_set_header('HTTP/1.0 404 Not Found');
321
  watchdog('page not found', check_plain($_GET['q']), WATCHDOG_WARNING);
322

323 324 325 326 327 328 329
  $return = '';

  if (variable_get('site_404_message_display', TRUE)) {
    $message = variable_get('site_404_message', t('We are sorry, the requested page was not found on this webserver. Either the URL does not exist or the page you were looking has been deleted.'));
    drupal_set_message(filter_xss_admin($message));
  }

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

335
  $path = drupal_get_normal_path(variable_get('site_404', ''));
336
  if (!empty($path) && $path != $_GET['q']) {
337
    menu_set_active_item($path);
338
    $return = menu_execute_active_handler();
339
  }
340
  else {
341
    // Redirect to a non-existent menu item to make possible tabs disappear.
342
    menu_set_active_item('');
343
  }
344

345 346 347
  if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
    drupal_set_title(t('404 - File not found'));
    $return = '&nbsp;';
348
  }
349 350
  // To conserve CPU and bandwidth, omit the blocks
  print theme('page', $return, FALSE);
351
}
352

353 354 355 356
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
357
  drupal_set_header('HTTP/1.0 403 Forbidden');
358
  watchdog('access denied', check_plain($_GET['q']), WATCHDOG_WARNING);
359

360 361 362 363 364 365 366 367
  $return = '';

  if (variable_get('site_403_message_display', TRUE)) {
    $message = variable_get('site_403_message', t('We are sorry, you do not have access to this page. If you are not already logged in, please try to login and then visit this page again. If you think should be able to access this page, please contact site admins.'));
    drupal_set_message(filter_xss_admin($message));
  }

  // Keep old path for reference
368 369 370 371
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

372
  $path = drupal_get_normal_path(variable_get('site_403', ''));
373
  if (!empty($path) && $path != $_GET['q']) {
374
    menu_set_active_item($path);
375
    $return = menu_execute_active_handler();
376
  }
377
  else {
378
    // Redirect to a non-existent menu item to make possible tabs disappear.
379
    menu_set_active_item('');
380
  }
381

382 383 384
  if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
    drupal_set_title(t('403 - Access denied'));
    $return = '&nbsp;';
385
  }
386
  print theme('page', $return);
387 388
}

389
/**
390
 * Perform an HTTP request.
391
 *
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
 * 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.
409 410
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
411 412
  $result = new StdClass();

413
  // Parse the URL, and make sure we can handle the schema.
414 415 416
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
417
      $port = isset($uri['port']) ? $uri['port'] : 80;
418
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
419
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
420 421
      break;
    case 'https':
422
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
423
      $port = isset($uri['port']) ? $uri['port'] : 443;
424
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
425
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
426 427
      break;
    default:
428
      $result->error = 'invalid schema '. $uri['scheme'];
429 430 431
      return $result;
  }

432
  // Make sure the socket opened properly.
433
  if (!$fp) {
434
    $result->error = trim($errno .' '. $errstr);
435 436 437
    return $result;
  }

438
  // Construct the path to act on.
439 440
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
441
    $path .= '?'. $uri['query'];
442 443
  }

444
  // Create HTTP request.
445
  $defaults = array(
446 447 448 449
    // 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",
450
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
451
    'Content-Length' => 'Content-Length: '. strlen($data)
452 453 454
  );

  foreach ($headers as $header => $value) {
455
    $defaults[$header] = $header .': '. $value;
456 457
  }

458
  $request = $method .' '. $path ." HTTP/1.0\r\n";
459 460 461
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
462
    $request .= $data ."\r\n";
463 464 465 466 467 468
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
469
  $response = '';
470 471
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
472 473 474 475
  }
  fclose($fp);

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

479
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
480 481 482
  $result->headers = array();

  // Parse headers.
483
  while ($line = trim(array_shift($split))) {
484
    list($header, $value) = explode(':', $line, 2);
485 486 487 488 489 490 491 492
    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);
    }
493 494 495 496 497 498 499 500 501 502
  }

  $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
503
  // the base code in their class.
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
  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;
}
531 532 533
/**
 * @} End of "HTTP handling".
 */
534

535
/**
536 537
 * Log errors as defined by administrator
 * Error levels:
538 539
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
540
 */
541
function error_handler($errno, $message, $filename, $line) {
542 543 544 545 546
  // If the @ error suppression operator was used, error_reporting is temporarily set to 0
  if (error_reporting() == 0) {
    return;
  }

547
  if ($errno & (E_ALL ^ E_NOTICE)) {
548 549
    $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 .'.';
550

551
    // Force display of error messages in update.php
552
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['PHP_SELF'], 'update.php')) {
553
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
554
    }
555 556

    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
557 558 559
  }
}

560
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
561
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
562 563 564
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
565
    $item = stripslashes($item);
566 567 568
  }
}

569 570 571 572
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
573
function fix_gpc_magic() {
574
  static $fixed = FALSE;
575
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
576 577 578 579
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
580
    $fixed = TRUE;
Dries's avatar
Dries committed
581
  }
582 583
}

584 585 586
/**
 * Initialize the localization system.
 */
587 588
function locale_initialize() {
  global $user;
589 590 591 592 593

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

594 595 596 597 598
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
599 600 601
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
602
  }
603
  if ($user->uid && isset($languages[$user->language])) {
604 605 606 607 608
    return $user->language;
  }
  else {
    return key($languages);
  }
609 610
}

611
/**
612
 * Translate strings to the current locale.
613
 *
614
 * When using t(), try to put entire sentences and strings in one t() call.
615 616 617 618
 * 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
619 620
 *   $msg = t('You must log in below or <a href="@url">create a new
 *             account</a> before viewing the next page.', array('@url'
621
 *             => url('user/register')));
622
 * @endcode
623 624 625
 * 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.
626
 *
627
 * @param $string
628
 *   A string containing the English string to translate.
629 630
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
631
 *   of any key in this array are replaced with the corresponding value.
632 633 634 635 636
 *   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)
637 638
 * @return
 *   The translated string.
639
 */
640
function t($string, $args = 0) {
641 642 643 644
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
645 646
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
647 648
  }
  else {
649 650
    // Transform arguments before inserting them
    array_walk($args, '_t');
651 652
    return strtr($string, $args);
  }
653 654
}

655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
/**
 * 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
670 671
    // Pass-through
    case '!':
672 673 674
  }
}

675
/**
676
 * @defgroup validation Input validation
677
 * @{
678
 * Functions to validate user input.
679 680
 */

681
/**
682 683 684
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
685
 *
686
 * @param $mail
687
 *   A string containing an e-mail address.
688
 * @return
689
 *   TRUE if the address is in a valid format.
690
 */
691
function valid_email_address($mail) {
692
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
693
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
694 695 696
  $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
697
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
698 699
}

700 701 702
/**
 * Verify the syntax of the given URL.
 *
703
 * @param $url
704
 *   The URL to verify.
705
 * @param $absolute
706
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
707
 * @return
708
 *   TRUE if the URL is in a valid format.
709
 */
710
function valid_url($url, $absolute = FALSE) {
711
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
712
  if ($absolute) {
713
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
714 715
  }
  else {
716
    return preg_match("/^". $allowed_characters ."+$/i", $url);
717
  }
718 719
}

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
/**
 * 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
740
 *   True if the user did not exceed the hourly threshold. False otherwise.
741 742 743 744 745 746
 */
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);
}

747 748
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
Dries committed
749 750
}

Dries's avatar
Dries committed
751 752 753 754 755
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
756
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
757 758
}

759
/**
760
 * @defgroup format Formatting
761
 * @{
762
 * Functions to format numbers, strings, dates, etc.
763 764
 */

765 766 767 768 769 770
/**
 * 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
771 772
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
773
  $output = "<channel>\n";
774 775
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
776 777 778 779 780

  // 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";
781
  $output .= ' <language>'. check_plain($language) ."</language>\n";
782
  $output .= format_xml_elements($args);
Dries's avatar
Dries committed
783 784 785 786 787 788
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

789 790 791 792 793
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
Dries committed
794
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
795
  $output = "<item>\n";
796 797 798
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
  $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)) {
822 823
      if ($value['key']) {
        $output .= ' <'. $value['key'];
824
        if (isset($value['attributes']) && is_array($value['attributes'])) {
825 826 827
          $output .= drupal_attributes($value['attributes']);
        }

828
        if ($value['value'] != '') {
829
          $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
830 831 832 833 834 835 836
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
837
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
838
    }
Dries's avatar
Dries committed
839
  }
Dries's avatar
Dries committed
840 841 842
  return $output;
}

843
/**
844
 * Format a string containing a count of items.
845
 *
846 847 848 849 850 851 852 853 854 855
 * 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,
856
 *   to ease translation. Use @count in place of the item count, as in "@count
857 858 859
 *   new comments".
 * @return
 *   A translated string.
860
 */
Dries's avatar
Dries committed
861
function format_plural($count, $singular, $plural) {
862
  if ($count == 1) return t($singular, array("@count" => $count));
863 864

  // get the plural index through the gettext formula
865
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
866
  if ($index < 0) { // backward compatibility
867
    return t($plural, array("@count" => $count));
868 869 870 871
  }
  else {
    switch ($index) {
      case "0":
872
        return t($singular, array("@count" => $count));
873
      case "1":
874
        return t($plural, array("@count" => $count));
875
      default:
876
        return t(strtr($plural, array("@count" => '@count['. $index .']')), array('@count['. $index .']' => $count));
877 878
    }
  }
Dries's avatar
Dries committed
879 880
}

881
/**
882
 * Generate a string representation for the given byte count.
883
 *
884 885 886 887
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
888
 */
Dries's avatar
Dries committed
889
function format_size($size) {
890
  $suffix = t('bytes');
891
  if ($size >= 1024) {
Dries's avatar
Dries committed
892
    $size = round($size / 1024, 2);
893
    $suffix = t('KB');
Dries's avatar
Dries committed
894
  }
895
  if ($size >= 1024) {
Dries's avatar
Dries committed
896
    $size = round($size / 1024, 2);
897
    $suffix = t('MB');
Dries's avatar
Dries committed
898
  }
899
  return t('@size @suffix', array('@size' => $size, '@suffix' => $suffix));
Dries's avatar
Dries committed
900 901
}

902
/**
903
 * Format a time interval with the requested granularity.
904
 *
905 906 907 908 909 910
 * @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.
911
 */
912
function format_interval($timestamp, $granularity = 2) {
913
  $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);
914
  $output = '';
915
  foreach ($units as $key => $value) {
916
    $key = explode('|', $key);
Dries's avatar
Dries committed
917
    if ($timestamp >= $value) {
918
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
Dries committed
919
      $timestamp %= $value;
920 921 922 923 924
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
Dries committed
925 926
    }
  }
927
  return $output ? $output : t('0 sec');
Dries's avatar
Dries committed
928 929
}

930
/**
931 932
 * Format a date with the given configured format or a custom format string.
 *
933 934 935 936
 * 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.
 *
937 938 939 940 941 942
 * @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
943 944 945
 *   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.
946 947 948 949
 * @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.
950
 */
951
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
952
  if (!isset($timezone)) {
953
    global $user;
Steven Wittens's avatar
Steven Wittens committed
954 955 956 957 958 959
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
960
  }
Dries's avatar
Dries committed
961

962
  $timestamp += $timezone;
Dries's avatar
Dries committed
963 964

  switch ($type) {
965 966
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
Dries committed
967
      break;
968 969
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
Dries committed
970
      break;
971
    case 'custom':
972
      // No change to format
Dries's avatar
Dries committed
973
      break;
974
    case 'medium':
Dries's avatar
Dries committed
975
    default:
976
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
977 978
  }

979
  $max = strlen($format);
980
  $date = '';
981
  for ($i = 0; $i < $max; $i++) {
982
    $c = $format[$i];
983
    if (strpos('AaDFlM', $c) !== FALSE) {
984
      $date .= t(gmdate($c, $timestamp));
985
    }
986
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== FALSE) {
987 988 989 990
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
991
    }
992 993 994 995 996
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
997
    }
998 999 1000
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
1001
    else {
1002
      $date .= $c;
1003
    }
Dries's avatar
Dries committed
1004
  }
1005

Dries's avatar
Dries committed
1006 1007 1008
  return $date;
}

1009 1010 1011
/**
 * @} End of "defgroup format".
 */
Dries's avatar
Dries committed
1012

1013
/**
1014
 * Generate a URL from a Drupal menu path. Will also pass-through existing URLs.
1015 1016
 *
 * @param $path
1017
 *   The Drupal path being linked to, such as "admin/content/node", or an existing URL
1018
 *   like "http://drupal.org/".
1019
 * @param $query
1020
 *   A query string to append to the link or URL.
1021
 * @param $fragment
1022 1023 1024
 *   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 '#'.
1025 1026
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
1027 1028
 *   Useful for links that will be displayed outside the site, such as in an
 *   RSS feed.
1029
 * @return
1030
 *   a string containing a URL to the given path.
1031 1032 1033 1034 1035
 *
 * 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) {
1036 1037 1038 1039 1040 1041
  if (isset($fragment)) {
    $fragment = '#'. $fragment;