common.inc 62.2 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.
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.
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
}

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

187 188 189
/**
 * @name HTTP handling
 * @{
190
 * Functions to properly handle HTTP responses.
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
  }
}

256
/**
257
 * Send the user to a different Drupal page.
258
 *
259 260
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
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.
 *
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.
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()
287
 */
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);
297

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);
302

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.
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', 'Drupal'))))));
317 318
}

319 320 321
/**
 * Generates a 404 error if the request can not be handled.
 */
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'];
  }

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

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

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);
355

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

361
  $path = drupal_get_normal_path(variable_get('site_403', ''));
drumm's avatar
drumm committed
362
  if ($path && $path != $_GET['q']) {
363
    menu_set_active_item($path);
364
    $return = menu_execute_active_handler();
365
  }
366
  else {
367
    // Redirect to a non-existent menu item to make possible tabs disappear.
368
    menu_set_active_item('');
369
  }
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.');
374
  }
375
  print theme('page', $return);
376 377
}

378
/**
379
 * Perform an HTTP request.
380
 *
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.
398 399
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
400 401
  $result = new StdClass();

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

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

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

433
  // Create HTTP request.
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)
441 442 443
  );

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

447
  $request = $method .' '. $path ." HTTP/1.0\r\n";
448 449 450
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
451
    $request .= $data ."\r\n";
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;
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);
469 470 471
  $result->headers = array();

  // Parse headers.
472
  while ($line = trim(array_shift($split))) {
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);
    }
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
492
  // the base code in their class.
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;
}
520 521 522
/**
 * @} End of "HTTP handling".
 */
523

524
/**
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.
529
 */
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)) {
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 .'.';
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
  }
}

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);
555 556 557
  }
}

558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
/**
 * Helper function to strip slashes from $_FILES skipping over the tmp_name keys
 * since PHP generates single backslashes for file paths on Windows systems.
 *
 * tmp_name does not have backslashes added see
 * http://php.net/manual/en/features.file-upload.php#42280
 */
function _fix_gpc_magic_files(&$item, $key) {
  if ($key != 'tmp_name') {
    if (is_array($item)) {
      array_walk($item, '_fix_gpc_magic_files');
    }
    else {
      $item = stripslashes($item);
    }
  }
}

576 577 578 579
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
580
function fix_gpc_magic() {
581
  static $fixed = FALSE;
582
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
583 584 585 586
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
587
    array_walk($_FILES, '_fix_gpc_magic_files');
588
    $fixed = TRUE;
Dries's avatar
Dries committed
589
  }
590 591
}

592 593 594
/**
 * Initialize the localization system.
 */
595 596
function locale_initialize() {
  global $user;
597 598 599 600 601

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

602 603 604 605 606
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
607 608 609
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
610
  }
611
  if ($user->uid && isset($languages[$user->language])) {
612 613 614 615 616
    return $user->language;
  }
  else {
    return key($languages);
  }
617 618
}

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

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

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

702 703 704
/**
 * Verify the syntax of the given URL.
 *
705 706 707
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
 *
708
 * @param $url
709
 *   The URL to verify.
710
 * @param $absolute
711
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
712
 * @return
713
 *   TRUE if the URL is in a valid format.
714
 */
715
function valid_url($url, $absolute = FALSE) {
716
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,;~=#&%\+]';
717
  if ($absolute) {
718
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
719 720
  }
  else {
721
    return preg_match("/^". $allowed_characters ."+$/i", $url);
722
  }
723 724
}

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

752 753
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
Dries committed
754 755
}

Dries's avatar
Dries committed
756 757 758 759 760
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
761
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
762 763
}

764
/**
765
 * @defgroup format Formatting
766
 * @{
767
 * Functions to format numbers, strings, dates, etc.
768 769
 */

770 771 772 773 774 775
/**
 * 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
776 777
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
778
  $output = "<channel>\n";
779 780
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
781 782 783 784 785

  // 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";
786
  $output .= ' <language>'. check_plain($language) ."</language>\n";
787
  $output .= format_xml_elements($args);
Dries's avatar
Dries committed
788 789 790 791 792 793
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

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

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

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

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

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

    if ($granularity == 0) {
      break;
Dries's avatar
Dries committed
930 931
    }
  }
932
  return $output ? $output : t('0 sec');
Dries's avatar
Dries committed
933 934
}

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

967
  $timestamp += $timezone;
Dries's avatar
Dries committed
968 969

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

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

Dries's avatar
Dries committed
1011 1012 1013
  return $date;
}

1014 1015 1016
/**
 * @} End of "defgroup format".
 */
Dries's avatar
Dries committed
1017

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