common.inc 56.7 KB
Newer Older
Dries's avatar
Dries committed
1
<?php
Dries's avatar
Dries committed
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
 * Set the title of the current page, for display on the page and in the title bar.
14
 */
15 16 17 18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
19
    $stored_title = $title;
20 21 22 23
  }
  return $stored_title;
}

24 25 26
/**
 * Get the title of the current page, for display on the page and in the title bar.
 */
27 28 29 30 31 32 33 34 35 36 37
function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    $title = menu_get_active_title();
  }

  return $title;
}

/**
38
 * Set the breadcrumb trail for the current page.
39
 *
40 41 42
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
43
 */
44 45 46 47 48 49 50 51 52
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

  if (isset($breadcrumb)) {
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

53 54 55
/**
 * Get the breadcrumb trail for the current page.
 */
56 57 58 59 60 61 62 63 64 65
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

  if (!isset($breadcrumb)) {
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
66
/**
67
 * Add output to the head tag of the HTML page.
Dries's avatar
Dries committed
68 69
 */
function drupal_set_html_head($data = NULL) {
70
  static $stored_head = '';
Dries's avatar
Dries committed
71 72

  if (!is_null($data)) {
73
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
74 75 76 77
  }
  return $stored_head;
}

78 79 80
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
81 82 83
function drupal_get_html_head() {
  global $base_url;

84
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
85
  $output .= "<base href=\"$base_url/\" />\n";
86
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
87 88 89 90

  return $output . drupal_set_html_head();
}

91
/**
92
 * Return an array mapping path aliases to their internal Drupal paths.
93
 */
94
function drupal_get_path_map($action = '') {
Dries's avatar
Dries committed
95
  static $map = NULL;
96

97
  if ($action == 'rebuild') {
98 99 100
    $map = NULL;
  }

Dries's avatar
Dries committed
101
  if (is_null($map)) {
102
    $map = array();  // Make $map non-null in case no aliases are defined.
103
    $result = db_query('SELECT * FROM {url_alias}');
104
    while ($data = db_fetch_object($result)) {
105
      $map[$data->dst] = $data->src;
106 107 108 109 110 111
    }
  }

  return $map;
}

112 113 114
/**
 * Regenerate the path map from the information in the database.
 */
115
function drupal_rebuild_path_map() {
116
  drupal_get_path_map('rebuild');
117
}
118 119

/**
120
 * Given an internal Drupal path, return the alias set by the administrator.
121
 */
122 123 124 125
function drupal_get_path_alias($path) {
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
126
  elseif (function_exists('conf_url_rewrite')) {
127 128
    return conf_url_rewrite($path, 'outgoing');
  }
129 130 131 132
  else {
    // No alias found. Return the normal path.
    return $path;
  }
133 134 135
}

/**
136
 * Given a path alias, return the internal path it represents.
137 138 139 140 141
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
142
  elseif (function_exists('conf_url_rewrite')) {
143 144 145 146 147 148
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
149

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

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

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

173 174 175
/**
 * @name HTTP handling
 * @{
176
 * Functions to properly handle HTTP responses.
177 178
 */

179
/**
180
 * Send the user to a different Drupal page.
181
 *
182 183
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
184
 *
185 186 187 188 189 190 191 192 193 194 195 196 197
 * It is advised to use drupal_goto() instead of PHP's header(), because
 * drupal_goto() will append the user's session ID to the URI when PHP is
 * compiled with "--enable-trans-sid".
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
 *   A Drupal path.
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
198
 */
199 200 201
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
  // Translate &amp; to simply & in the absolute URL.
  $url = str_replace('&amp;', '&', url($path, $query, $fragment, TRUE));
202

203 204
  if (ini_get('session.use_trans_sid') && session_id() && !strstr($url, session_id())) {
    $sid = session_name() . '=' . session_id();
205

206 207
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
208 209
    }
    else {
210
      $url = $url .'?'. $sid;
211 212 213
    }
  }

214 215 216 217
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

219 220 221
  // 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.
222 223 224 225 226 227
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
228
function drupal_not_found() {
229
  header('HTTP/1.0 404 Not Found');
230
  watchdog('httpd', t('404 error: %page not found.', array('%page' => '<em>'. check_query($_GET['q']) .'</em>')));
231 232

  $path = drupal_get_normal_path(variable_get('site_404', ''));
233
  $status = MENU_NOT_FOUND;
234 235
  if ($path) {
    menu_set_active_item($path);
236
    $status = menu_execute_active_handler();
237 238
  }

239
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
240
    print theme('page', '', t('Page not found'));
241 242
  }
}
243

244 245 246 247 248 249 250
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');

  $path = drupal_get_normal_path(variable_get('site_403', ''));
251
  $status = MENU_NOT_FOUND;
252 253 254 255 256 257 258 259 260 261
  if ($path) {
    menu_set_active_item($path);
    $status = menu_execute_active_handler();
  }

  if ($status != MENU_FOUND) {
    print theme('page', message_access(), t('Access denied'));
  }
}

262
/**
263
 * Perform an HTTP request.
264
 *
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
 * 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.
282 283
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
284
  // Parse the URL, and make sure we can handle the schema.
285 286 287 288 289 290
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
      $fp = @fsockopen($uri['host'], ($uri['port'] ? $uri['port'] : 80), $errno, $errstr, 15);
      break;
    case 'https':
291 292
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
      $fp = @fsockopen('ssl://'. $uri['host'], ($uri['port'] ? $uri['port'] : 443), $errno, $errstr, 20);
293 294
      break;
    default:
295
      $result->error = 'invalid schema '. $uri['scheme'];
296 297 298
      return $result;
  }

299
  // Make sure the socket opened properly.
300
  if (!$fp) {
301
    $result->error = trim($errno .' '. $errstr);
302 303 304
    return $result;
  }

305
  // Construct the path to act on.
306 307
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
308
    $path .= '?'. $uri['query'];
309 310
  }

311
  // Create HTTP request.
312
  $defaults = array(
313
    'Host' => 'Host: '. $uri['host'],
314 315
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
316 317 318
  );

  foreach ($headers as $header => $value) {
319
    $defaults[$header] = $header .': '. $value;
320 321
  }

322
  $request = $method .' '. $path ." HTTP/1.0\r\n";
323 324 325
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
326
    $request .= $data ."\r\n";
327 328 329 330 331 332
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
333
  $response = '';
334
  while (!feof($fp) && $data = fread($fp, 1024)) {
335
    $response .= $data;
336 337 338 339
  }
  fclose($fp);

  // Parse response.
340 341 342 343
  list($headers, $result->data) = explode("\r\n\r\n", $response, 2);
  $headers = preg_split("/\r\n|\n|\r/", $headers);

  list($protocol, $code, $text) = explode(' ', trim(array_shift($headers)), 3);
344 345 346
  $result->headers = array();

  // Parse headers.
347
  while ($line = trim(array_shift($headers))) {
348 349 350 351 352 353 354 355 356 357 358 359
    list($header, $value) = explode(':', $line, 2);
    $result->headers[$header] = trim($value);
  }

  $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
360
  // the base code in their class.
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
  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;
}
388 389 390
/**
 * @} End of "HTTP handling".
 */
391

392
/**
393 394 395 396
 * Log errors as defined by administrator
 * Error levels:
 *  1 = Log errors to database.
 *  2 = Log errors to database and to screen.
397
 */
Dries's avatar
Dries committed
398
function error_handler($errno, $message, $filename, $line, $variables) {
399 400 401
  if ($errno & E_ALL ^ E_NOTICE) {
    $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 .'.';
402

403
    watchdog('error', t('%error: %message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)));
404 405

    if (variable_get('error_level', 1) == 1) {
406
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
407
    }
Dries's avatar
Dries committed
408 409 410
  }
}

Dries's avatar
Dries committed
411 412
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
413 414 415
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
416
    $item = stripslashes($item);
417 418 419
  }
}

420 421 422 423
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
424 425
function fix_gpc_magic() {
  static $fixed = false;
426
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
427 428 429 430 431 432
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
    $fixed = true;
  }
433 434
}

435 436 437
/**
 * @name Conversion
 * @{
438
 * Converts data structures to different types.
439
 */
440 441 442 443

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
444 445
function array2object($array) {
  if (is_array($array)) {
446
    $object = new stdClass();
Dries's avatar
Dries committed
447
    foreach ($array as $key => $value) {
Dries's avatar
Dries committed
448 449 450 451
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
452
    $object = $array;
Dries's avatar
Dries committed
453 454 455 456 457
  }

  return $object;
}

458 459 460
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
461 462 463
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
Dries committed
464 465 466 467
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
468
    $array = $object;
Dries's avatar
Dries committed
469 470 471 472
  }

  return $array;
}
473 474 475 476

/**
 * @} End of "Conversion".
 */
Dries's avatar
Dries committed
477

478 479 480
/**
 * @name Messages
 * @{
481
 * Frequently used messages.
482
 */
483 484 485 486 487 488 489

/**
 * Return a string with an "access denied" message.
 *
 * Always consider whether to use drupal_access_denied() instead to return a
 * proper (and customizable) 403 error.
 */
Dries's avatar
Dries committed
490
function message_access() {
491
  return t('You are not authorized to access this page.');
Dries's avatar
Dries committed
492 493
}

494 495 496
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
Dries committed
497
function message_na() {
498
  return t('n/a');
Dries's avatar
Dries committed
499 500
}

501 502 503
/**
 * @} End of "Messages".
 */
Dries's avatar
Dries committed
504

505 506 507
/**
 * Initialize the localization system.
 */
508 509
function locale_initialize() {
  global $user;
510 511 512 513 514

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

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

532
/**
533
 * Translate strings to the current locale.
534
 *
535
 * When using t(), try to put entire sentences and strings in one t() call.
536 537 538 539
 * 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
540 541 542
 *   $msg = t('You must log in below or <a href="%url">create a new
 *             account</a> before viewing the next page.', array('%url'
 *             => url('user/register')));
543
 * @endcode
544 545 546
 * 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.
547
 *
548
 * @param $string
549
 *   A string containing the English string to translate.
550 551
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
552
 *   of any key in this array are replaced with the corresponding value.
553 554
 * @return
 *   The translated string.
555
 */
556
function t($string, $args = 0) {
557 558 559 560
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
561

562 563
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
564 565
  }
  else {
566 567
    return strtr($string, $args);
  }
568 569
}

570 571 572 573 574 575 576 577
/**
 * Encode special characters in a string for display as HTML.
 *
 * Note that we'd like to use htmlspecialchars($input, $quotes, 'utf-8')
 * as outlined in the PHP manual, but we can't because there's a bug in
 * PHP < 4.3 that makes it mess up multibyte charsets if we specify the
 * charset. This will be changed later once we make PHP 4.3 a requirement.
 */
578
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
579
  return htmlspecialchars($input, $quotes);
580 581
}

582
/**
583
 * @defgroup validation Input validation
584
 * @{
585
 * Functions to validate user input.
586 587
 */

588
/**
589 590 591
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
592
 *
593 594
 * @param $mail
 *   A string containing an email address.
595
 * @return
596
 *   TRUE if the address is in a valid format.
597
 */
598
function valid_email_address($mail) {
599
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
600
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
601 602 603
  $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
604
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
605 606
}

607 608 609
/**
 * Verify the syntax of the given URL.
 *
610
 * @param $url
611
 *   The URL to verify.
612
 * @param $absolute
613
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
614
 * @return
615
 *   TRUE if the URL is in a valid format.
616
 */
617
function valid_url($url, $absolute = FALSE) {
618
  if ($absolute) {
619
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&%]+$/i", $url);
620 621
  }
  else {
622
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
623
  }
624 625
}

626 627 628 629 630 631 632 633 634 635
/**
 * Validate data input by a user.
 *
 * Ensures that user data cannot be used to perform attacks on the site.
 *
 * @param $data
 *   The input to check.
 * @return
 *   TRUE if the input data is acceptable.
 */
636 637
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
638
    // Form data can contain a number of nested arrays.
639
    foreach ($data as $key => $value) {
Dries's avatar
Dries committed
640
      if (!valid_input_data($key) || !valid_input_data($value)) {
641
        return FALSE;
642 643 644 645
      }
    }
  }
  else {
646
    // Detect dangerous input data.
647

648 649 650 651
    // Check strings:
    $match  = preg_match('/\Wjavascript\s*:/i', $data);
    $match += preg_match('/\Wexpression\s*\(/i', $data);
    $match += preg_match('/\Walert\s*\(/i', $data);
652

653
    // Check attributes:
654 655
    $match += preg_match("/\W(dynsrc|datasrc|data|lowsrc|on[a-z]+)\s*=[^>]+?>/i", $data);

656
    // Check tags:
657 658 659
    $match += preg_match("/<\s*(applet|script|object|style|embed|form|blink|meta|html|frame|iframe|layer|ilayer|head|frameset|xml)/i", $data);

    if ($match) {
660
      watchdog('warning', t('Terminated request because of suspicious input data: %data.', array('%data' => '<em>'. drupal_specialchars($data) .'</em>')));
661
      return FALSE;
662 663 664
    }
  }

665
  return TRUE;
666
}
667 668 669
/**
 * @} End of "defgroup validation".
 */
670

Dries's avatar
Dries committed
671
function check_form($text) {
672
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
Dries committed
673 674
}

675 676
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
Dries committed
677 678
}

679
/**
680
 * @defgroup format Formatting
681
 * @{
682
 * Functions to format numbers, strings, dates, etc.
683 684
 */

685 686 687 688 689 690
/**
 * 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
691 692
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
693
  $output = "<channel>\n";
694 695 696 697
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= ' <description>'. drupal_specialchars(strip_tags($description)) ."</description>\n";
  $output .= ' <language>'. drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
Dries committed
698
  foreach ($args as $key => $value) {
699
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
Dries committed
700
  }
Dries's avatar
Dries committed
701 702 703 704 705 706
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

707 708 709 710 711
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
Dries committed
712
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
713
  $output = "<item>\n";
714 715
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
716
  $output .= ' <description>'. drupal_specialchars($description) ."</description>\n";
Dries's avatar
Dries committed
717
  foreach ($args as $key => $value) {
718
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
Dries committed
719
  }
Dries's avatar
Dries committed
720 721 722 723 724
  $output .= "</item>\n";

  return $output;
}

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

  // get the plural index through the gettext formula
  $index = (function_exists('locale')) ? locale_get_plural($count) : -1;
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
754
        return t($singular, array("%count" => $count));
755 756 757 758 759 760
      case "1":
        return t($plural, array("%count" => $count));
      default:
        return t(strtr($plural, array("%count" => '%count['. $index .']')), array('%count['. $index .']' => $count));
    }
  }
Dries's avatar
Dries committed
761 762
}

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

784
/**
785
 * Format a time interval with the requested granularity.
786
 *
787 788 789 790 791 792
 * @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.
793
 */
794
function format_interval($timestamp, $granularity = 2) {
795
  $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);
796
  $output = '';
797
  foreach ($units as $key => $value) {
798
    $key = explode('|', $key);
Dries's avatar
Dries committed
799
    if ($timestamp >= $value) {
800
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
Dries committed
801
      $timestamp %= $value;
802 803 804 805 806
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
Dries committed
807 808
    }
  }
809
  return $output ? $output : t('0 sec');
Dries's avatar
Dries committed
810 811
}

812
/**
813 814
 * Format a date with the given configured format or a custom format string.
 *
815 816 817 818
 * 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.
 *
819 820 821 822 823 824 825 826 827 828 829
 * @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
 *   A PHP date format string as required by date().
 * @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.
830
 */
831 832 833
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
834 835 836 837 838 839
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
840
  }
Dries's avatar
Dries committed
841

842
  $timestamp += $timezone;
Dries's avatar
Dries committed
843 844

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

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

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

886
/**
887
 * Format a username.
888
 *
889 890 891 892 893
 * @param $object
 *   The user object to format, usually returned from user_load().
 * @return
 *   A string containing an HTML link to the user's page if the passed object
 *   suggests that this is a site user. Otherwise, only the username is returned.
894
 */
Dries's avatar
Dries committed
895 896 897
function format_name($object) {

  if ($object->uid && $object->name) {
898
    // Shorten the name when it is too long or it will break many tables.
899
    if (strlen($object->name) > 20) {
900
      $name = truncate_utf8($object->name, 15) .'...';
901 902 903 904 905
    }
    else {
      $name = $object->name;
    }

906
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries's avatar
Dries committed
907
  }
908
  else if ($object->name) {
909 910 911 912
    // Sometimes modules display content composed by people who are
    // not registered members of the site (e.g. mailing list or news
    // aggregator modules). This clause enables modules to display
    // the true author of the content.
913
    if ($object->homepage) {
914
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
915 916 917 918 919 920
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
921
  }
Dries's avatar
Dries committed
922
  else {
923
    $output = t(variable_get('anonymous', 'Anonymous'));
Dries's avatar
Dries committed
924 925
  }

926
  return $output;
Dries's avatar
Dries committed
927
}
928 929 930
/**
 * @} End of "defgroup format".
 */
Dries's avatar
Dries committed
931

932
/**
933
 * @defgroup form Form generation
934
 * @{
935
 * Functions to enable output of HTML forms and form elements.
936
 *
937 938
 * Drupal uses these functions to achieve consistency in its form presentation,
 * while at the same time simplifying code and reducing the amount of HTML that
939
 * must be explicitly generated by modules.
940
 */
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956

/**
 * Generate a form from a set of form elements.
 *
 * @param $form
 *   An HTML string containing one or more form elements.
 * @param $method
 *   The query method to use ("post" or "get").
 * @param $action
 *   The URL to send the form contents to, if not the current page.
 * @param $attributes
 *   An associative array of attributes to add to the form tag.
 * @result
 *   An HTML string with the contents of $form wrapped in a form tag.
 */
function form($form, $method = 'post', $action = NULL, $attributes = NULL) {
957
  if (!$action) {
958
    $action = request_uri();
959
  }
960
  return '<form action="'. $action .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
Dries committed
961 962
}

Dries's avatar
Dries committed
963
/**
964
 * File an error against the form element with the specified name.
Dries's avatar
Dries committed
965 966 967 968 969 970 971
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
972
 * Return an associative array of all errors.
Dries's avatar
Dries committed
973
 */
974
function form_get_errors() {
975 976 977
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
Dries committed
978 979 980 981 982 983
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
984 985 986
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
Dries committed
987 988 989 990 991 992
}

function _form_get_class($name, $required, $error) {
  return $name. ($required ? ' required' : '') . ($error ? ' error' : '');
}

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
/**
 * Format a general form item.
 *
 * @param $title
 *   The label for the form item.
 * @param $value
 *   The contents of the form item.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $id
 *   A unique identifier for the form item.
 * @param $required
 *   Whether the user must fill in this form element before submitting the form.
 * @param $error
 *   An error message to display alongside the form element.
 * @return
 *   A themed HTML string representing the form item.
 */
Dries's avatar
Dries committed
1011
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
1012
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
Dries committed
1013
}
1014

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
/**
 * Format a group of form items.
 *
 * @param $legend
 *   The label for the form item group.
 * @param $group
 *   The form items within the group, as an HTML string.
 * @param $description
 *   Explanatory text to display after the form item group.
 * @return
 *   A themed HTML string representing the form item group.
 */
1027
function form_group($legend, $group, $description = NULL) {
1028
  return '<fieldset>' . ($legend ? '<legend>'. $legend .'</legend>' : '') . $group . ($description ? '<div class="description">'. $description .'</div>' : '') . "</fieldset>\n";
1029
}
Dries's avatar
Dries committed
1030

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
/**
 * Format a radio button.
 *
 * @param $title
 *   The label for the radio button.
 * @param $name
 *   The internal name used to refer to the button.
 * @param $value
 *   The value that the form element takes on when selected.
 * @param $checked
 *   Whether the button will be initially selected when the page is rendered.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $attributes
 *   An associative array of HTML attributes to add to the button.
 * @param $required
 *   Whether the user must select this radio button before submitting the form.
 * @return
 *   A themed HTML string representing the radio button.
 */
function form_radio($title, $name, $value = 1, $checked = FALSE, $description = NULL, $attributes = NULL, $required = FALSE) {
  $element = '<input type="radio" class="'. _form_get_class('form-radio', $required, _form_get_error($name)) .'" name="edit['. $name .']" value="'. $value .'"'. ($checked ? ' checked="checked"' : '') . drupal_attributes($attributes) .' />';
1053
  if (!is_null($title)) {
1054
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1055
  }
1056
  return theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
1057 1058
}

1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
/**
 * Format a set of radio buttons.
 *
 * @param $title
 *   The label for the radio buttons as a group.
 * @param $name
 *   The internal name used to refer to the buttons.
 * @param $value
 *   The currently selected radio button's key.
 * @param $options
 *   An associative array of buttons to display. The keys in this array are
 *   button values, while the values are the labels to display for each button.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $required
 *   Whether the user must select a radio button before submitting the form.
 * @param $attributes
 *   An associative array of HTML attributes to add to each button.
 * @return
 *   A themed HTML string representing the radio button set.
 */
1080
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {
1081
  if (count($options) > 0) {
1082
    $choices = '';
1083
    foreach ($options as $key => $choice) {
1084
      $choices .= '<label class="option"><input type="radio" class="form-radio" name="edit['. $name .']" value="'. $key .'"'. ($key == $value ? ' checked="checked"' : ''). drupal_attributes($attributes). ' /> '. $choice .'</label><br />';
1085
    }