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

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

/**
 * Get assigned content.
 *
 * @param $region
 *   A specified region to fetch content for.  If null, all regions will be returned.
 *
 * @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";
118
  $output .= theme('stylesheet_import', base_path() .'misc/drupal.css');
Dries's avatar
Dries committed
119 120 121
  return $output . drupal_set_html_head();
}

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

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

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

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

152 153 154
/**
 * @name HTTP handling
 * @{
155
 * Functions to properly handle HTTP responses.
156 157
 */

158 159
/**
 * Prepare a destination query string for use in combination with
160 161 162 163 164
 * 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
 * is returned.  As such, a destination can persist across multiple
 * pages.
165 166 167 168
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
169 170 171 172
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
173 174 175 176 177
    $path = $_GET['q'];
    $params = array();
    foreach ($_GET as $key => $value) {
      if ($key == 'q') {
        continue;
178
      }
179
      $params[] = urlencode($key) .'='. urlencode($value);
180
    }
181 182 183 184
    if (count($params)) {
      $path .= '?';
    }
    return 'destination='. urlencode($path . implode('&', $params));
185 186 187
  }
}

188
/**
189
 * Send the user to a different Drupal page.
190
 *
191 192
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
193
 *
194 195 196 197 198 199 200 201 202 203
 * Usually the redirected URL is constructed from this function's input
 * parameters.  However you may override that behavior by setting a
 * <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
 * 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
 * a post on the 'admin/node'-page or after having logged on using the
 * 'user login'-block in a sidebar.  The function drupal_get_destination()
 * can be used to help set the destination URL.
 *
204 205 206 207 208 209 210 211 212 213 214 215 216
 * 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).
217 218
 *
 * @see drupal_get_destination()
219
 */
220
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
221 222 223 224 225 226 227
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

228
  $url = url($path, $query, $fragment, TRUE);
229

230 231 232 233
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

235 236 237
  // 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.
238 239 240
  exit();
}

241
/**
242
 * Generates a site off-line message
243 244
 */
function drupal_site_offline() {
245
  drupal_set_header('HTTP/1.0 503 Service unavailable');
246
  drupal_set_title(t('Site off-line'));
247
  print theme('maintenance_page', variable_get('site_offline_message',
248
    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'))))));
249 250
}

251 252 253
/**
 * Generates a 404 error if the request can not be handled.
 */
254
function drupal_not_found() {
255
  drupal_set_header('HTTP/1.0 404 Not Found');
256
  watchdog('page not found', t('%page not found.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING);
257 258

  $path = drupal_get_normal_path(variable_get('site_404', ''));
259
  if ($path && $path != $_GET['q']) {
260
    menu_set_active_item($path);
261
    $return = menu_execute_active_handler();
262 263
  }

264
  if (empty($return)) {
265
    drupal_set_title(t('Page not found'));
266
  }
267
  print theme('page', $return);
268
}
269

270 271 272 273
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
274
  drupal_set_header('HTTP/1.0 403 Forbidden');
275
  watchdog('access denied', t('%page denied access.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
276 277

  $path = drupal_get_normal_path(variable_get('site_403', ''));
278
  if ($path && $path != $_GET['q']) {
279
    menu_set_active_item($path);
280
    $return = menu_execute_active_handler();
281 282
  }

283
  if (empty($return)) {
284
    drupal_set_title(t('Access denied'));
285
    $return = t('You are not authorized to access this page.');
286
  }
287
  print theme('page', $return);
288 289
}

290
/**
291
 * Perform an HTTP request.
292
 *
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
 * 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.
310 311
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
312 313
  $result = new StdClass();

314
  // Parse the URL, and make sure we can handle the schema.
315 316 317
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
318
      $port = isset($uri['port']) ? $uri['port'] : 80;
319
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
320
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
321 322
      break;
    case 'https':
323
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
324
      $port = isset($uri['port']) ? $uri['port'] : 443;
325
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
326
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
327 328
      break;
    default:
329
      $result->error = 'invalid schema '. $uri['scheme'];
330 331 332
      return $result;
  }

333
  // Make sure the socket opened properly.
334
  if (!$fp) {
335
    $result->error = trim($errno .' '. $errstr);
336 337 338
    return $result;
  }

339
  // Construct the path to act on.
340 341
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
342
    $path .= '?'. $uri['query'];
343 344
  }

345
  // Create HTTP request.
346
  $defaults = array(
347 348 349 350
    // 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",
351
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
352
    'Content-Length' => 'Content-Length: '. strlen($data)
353 354 355
  );

  foreach ($headers as $header => $value) {
356
    $defaults[$header] = $header .': '. $value;
357 358
  }

359
  $request = $method .' '. $path ." HTTP/1.0\r\n";
360 361 362
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
363
    $request .= $data ."\r\n";
364 365 366 367 368 369
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
370
  $response = '';
371 372
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
373 374 375 376
  }
  fclose($fp);

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

380
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
381 382 383
  $result->headers = array();

  // Parse headers.
384
  while ($line = trim(array_shift($split))) {
385
    list($header, $value) = explode(':', $line, 2);
386 387 388 389 390 391 392 393
    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);
    }
394 395 396 397 398 399 400 401 402 403
  }

  $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
404
  // the base code in their class.
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
  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;
}
432 433 434
/**
 * @} End of "HTTP handling".
 */
435

436
/**
437 438
 * Log errors as defined by administrator
 * Error levels:
439 440
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
441
 */
442
function error_handler($errno, $message, $filename, $line) {
443
  if ($errno & (E_ALL ^ E_NOTICE)) {
444 445
    $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 .'.';
446

447
    if (variable_get('error_level', 1) == 1) {
448
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
449
    }
450 451

    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
452 453 454
  }
}

455
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
456
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
457 458 459
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
460
    $item = stripslashes($item);
461 462 463
  }
}

464 465 466 467
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
468 469
function fix_gpc_magic() {
  static $fixed = false;
470
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
471 472 473 474 475 476
    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;
  }
477 478
}

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

/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
Dries committed
488
function message_na() {
489
  return t('n/a');
Dries's avatar
Dries committed
490 491
}

492 493 494
/**
 * @} End of "Messages".
 */
Dries's avatar
Dries committed
495

496 497 498
/**
 * Initialize the localization system.
 */
499 500
function locale_initialize() {
  global $user;
501 502 503 504 505

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

506 507 508 509 510
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
511 512 513
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
514
  }
515
  if ($user->uid && isset($languages[$user->language])) {
516 517 518 519 520
    return $user->language;
  }
  else {
    return key($languages);
  }
521 522
}

523
/**
524
 * Translate strings to the current locale.
525
 *
526
 * When using t(), try to put entire sentences and strings in one t() call.
527 528 529 530
 * 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
531 532 533
 *   $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')));
534
 * @endcode
535 536 537
 * 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.
538
 *
539
 * @param $string
540
 *   A string containing the English string to translate.
541 542
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
543
 *   of any key in this array are replaced with the corresponding value.
544 545
 * @return
 *   The translated string.
546
 */
547
function t($string, $args = 0) {
548 549 550 551
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
552

553 554
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
555 556
  }
  else {
557 558
    return strtr($string, $args);
  }
559 560
}

561
/**
562
 * @defgroup validation Input validation
563
 * @{
564
 * Functions to validate user input.
565 566
 */

567
/**
568 569 570
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
571
 *
572
 * @param $mail
573
 *   A string containing an e-mail address.
574
 * @return
575
 *   TRUE if the address is in a valid format.
576
 */
577
function valid_email_address($mail) {
578
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
579
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
580 581 582
  $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
583
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
584 585
}

586 587 588
/**
 * Verify the syntax of the given URL.
 *
589
 * @param $url
590
 *   The URL to verify.
591
 * @param $absolute
592
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
593
 * @return
594
 *   TRUE if the URL is in a valid format.
595
 */
596
function valid_url($url, $absolute = FALSE) {
597
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
598
  if ($absolute) {
599
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
600 601
  }
  else {
602
    return preg_match("/^". $allowed_characters ."+$/i", $url);
603
  }
604 605
}

606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
/**
 * 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
 *   True if the user did not exceed the hourly threshold.  False otherwise.
 */
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);
}

633 634
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
Dries committed
635 636
}

Dries's avatar
Dries committed
637 638 639 640 641
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
642
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
643 644
}

645
/**
646
 * @defgroup format Formatting
647
 * @{
648
 * Functions to format numbers, strings, dates, etc.
649 650
 */

651 652 653 654 655 656
/**
 * 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
657 658
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
659
  $output = "<channel>\n";
660 661 662 663
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
  $output .= ' <language>'. check_plain($language) ."</language>\n";
Dries's avatar
Dries committed
664
  foreach ($args as $key => $value) {
665
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
Dries committed
666
  }
Dries's avatar
Dries committed
667 668 669 670 671 672
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

673 674 675 676 677
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
Dries committed
678
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
679
  $output = "<item>\n";
680 681 682
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
Dries's avatar
Dries committed
683
  foreach ($args as $key => $value) {
684 685 686
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
687
        if (isset($value['attributes']) && is_array($value['attributes'])) {
688 689 690 691 692 693 694 695 696 697 698 699
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
700
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
701
    }
Dries's avatar
Dries committed
702
  }
Dries's avatar
Dries committed
703 704 705 706 707
  $output .= "</item>\n";

  return $output;
}

708
/**
709
 * Format a string containing a count of items.
710
 *
711 712 713 714 715 716 717 718 719 720 721 722 723 724
 * 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.
725
 */
Dries's avatar
Dries committed
726
function format_plural($count, $singular, $plural) {
727
  if ($count == 1) return t($singular, array("%count" => $count));
728 729

  // get the plural index through the gettext formula
730
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
731 732 733 734 735 736
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
737
        return t($singular, array("%count" => $count));
738 739 740 741 742 743
      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
744 745
}

746
/**
747
 * Generate a string representation for the given byte count.
748
 *
749 750 751 752
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
753
 */
Dries's avatar
Dries committed
754
function format_size($size) {
755
  $suffix = t('bytes');
756
  if ($size >= 1024) {
Dries's avatar
Dries committed
757
    $size = round($size / 1024, 2);
758
    $suffix = t('KB');
Dries's avatar
Dries committed
759
  }
760
  if ($size >= 1024) {
Dries's avatar
Dries committed
761
    $size = round($size / 1024, 2);
762
    $suffix = t('MB');
Dries's avatar
Dries committed
763
  }
764
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
Dries committed
765 766
}

767
/**
768
 * Format a time interval with the requested granularity.
769
 *
770 771 772 773 774 775
 * @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.
776
 */
777
function format_interval($timestamp, $granularity = 2) {
778
  $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);
779
  $output = '';
780
  foreach ($units as $key => $value) {
781
    $key = explode('|', $key);
Dries's avatar
Dries committed
782
    if ($timestamp >= $value) {
783
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
Dries committed
784
      $timestamp %= $value;
785 786 787 788 789
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
Dries committed
790 791
    }
  }
792
  return $output ? $output : t('0 sec');
Dries's avatar
Dries committed
793 794
}

795
/**
796 797
 * Format a date with the given configured format or a custom format string.
 *
798 799 800 801
 * 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.
 *
802 803 804 805 806 807
 * @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
808 809 810
 *   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.
811 812 813 814
 * @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.
815
 */
816
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
817
  if (!isset($timezone)) {
818
    global $user;
Steven Wittens's avatar
Steven Wittens committed
819 820 821 822 823 824
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
825
  }
Dries's avatar
Dries committed
826

827
  $timestamp += $timezone;
Dries's avatar
Dries committed
828 829

  switch ($type) {
830 831
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
Dries committed
832
      break;
833 834
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
Dries committed
835
      break;
836
    case 'custom':
837
      // No change to format
Dries's avatar
Dries committed
838
      break;
839
    case 'medium':
Dries's avatar
Dries committed
840
    default:
841
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
842 843
  }

844
  $max = strlen($format);
845
  $date = '';
846
  for ($i = 0; $i < $max; $i++) {
847
    $c = $format[$i];
848
    if (strpos('AaDFlM', $c) !== false) {
849
      $date .= t(gmdate($c, $timestamp));
850
    }
851
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
852 853 854 855
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
856
    }
857 858 859 860 861
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
862
    }
863 864 865
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
866
    else {
867
      $date .= $c;
868
    }
Dries's avatar
Dries committed
869
  }
870

Dries's avatar
Dries committed
871 872 873
  return $date;
}

874 875 876
/**
 * @} End of "defgroup format".
 */
Dries's avatar
Dries committed
877

878
/**
879
 * Generate a URL from a Drupal menu path. Will also pass-through existing URLs.
880 881
 *
 * @param $path
882 883
 *   The Drupal path being linked to, such as "admin/node", or an existing URL
 *   like "http://drupal.org/".
884
 * @param $query
885
 *   A query string to append to the link or URL.
886
 * @param $fragment
887 888 889
 *   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 '#'.
890 891
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
892 893
 *   Useful for links that will be displayed outside the site, such as in an
 *   RSS feed.
894 895 896 897 898 899 900
 * @return
 *   an HTML string containing a link to the given path.
 *
 * 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) {
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
  if (isset($fragment)) {
    $fragment = '#'. $fragment;
  }

  // Return an external link if $path contains an allowed absolute URL.
  // Only call the slow filter_xss_bad_protocol if $path contains a ':'.
  if (strpos($path, ':') !== FALSE && filter_xss_bad_protocol($path) == $path) {
    // Split off the fragment
    if (strpos($path, '#')) {
      list($path, $old_fragment) = explode('#', $path, 2);
      if (isset($old_fragment) && !isset($fragment)) {
        $fragment = '#'. $old_fragment;
      }
    }
    // Append the query
    if (isset($query)) {
      $path .= (strpos($path, '?') ? '&' : '?') . $query;
    }
    // Reassemble
    return $path . $fragment;
  }
Dries's avatar
Dries committed
922

923
  global $base_url;
924
  static $script;
925
  static $clean_url;
926 927

  if (empty($script)) {
928 929 930
    // On some web servers, such as IIS, we can't omit "index.php".  So, we
    // generate "index.php?q=foo" instead of "?q=foo" on anything that is not
    // Apache.
931
    $script = (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') === false) ? 'index.php' : '';
932
  }
933

934
  // Cache the clean_url variable to improve performance.
935 936
  if (!isset($clean_url)) {
    $clean_url = (bool)variable_get('clean_url', '0');
937
  }
938

939
  $base = ($absolute ? $base_url . '/' : base_path());
Dries's avatar
Dries committed
940

941 942 943 944 945
  // The special path '<front>' links to the default front page.
  if (isset($path) && $path != '<front>') {
    $path = drupal_get_path_alias($path);
    $path = drupal_urlencode($path);
    if (!$clean_url) {
Dries's avatar
Dries committed
946
      if (isset($query)) {
947
        return $base . $script .'?q='. $path .'&'. $query . $fragment;
Dries's avatar
Dries committed
948 949
      }
      else {
950
        return $base . $script .'?q='. $path . $fragment;
Dries's avatar
Dries committed
951
      }
952 953
    }
    else {
Dries's avatar
Dries committed
954
      if (isset($query)) {
955
        return $base . $path .'?'. $query . $fragment;
Dries's avatar
Dries committed
956 957
      }
      else {
958
        return $base . $path . $fragment;
Dries's avatar
Dries committed
959
      }
960 961 962
    }
  }
  else {
963 964
    if (isset($query)) {
      return $base . $script .'?'. $query . $fragment;
965
    }
966
    else {
967
      return $base . $fragment;
968
    }
969
  }
970 971
}

972 973 974 975 976 977 978 979
/**
 * Format an attribute string to insert in a tag.
 *
 * @param $attributes
 *   An associative array of HTML attributes.
 * @return
 *   An HTML string ready for insertion in a tag.
 */
980
function drupal_attributes($attributes = array()) {
981
  if (is_array($attributes)) {
982 983
    $t = array();
    foreach ($attributes as $key => $value) {
984
      $t[] = $key .'="'. check_plain($value) .'"';
985
    }
986
    return ' '. implode(' ', $t);
Dries's avatar
Dries committed
987
  }
988
}
Dries's avatar
Dries committed
989

990 991 992 993 994 995 996 997 998 999
/**
 * Format an internal Drupal link.
 *
 * This function correctly handles aliased paths, and allows themes to highlight
 * links to the current page correctly, so all internal links output by modules
 * should be generated by this function if possible.
 *
 * @param $text
 *   The text to be enclosed with the anchor tag.
 * @param $path
1000 1001
 *   The Drupal path being linked to, such as "admin/node". Note, this must be a
 *   system URL as the url() function will generate the alias.
1002 1003 1004 1005 1006 1007 1008 1009 1010
 * @param $attributes
 *   An associative array of HTML attributes to apply to the anchor tag.
 * @param $query
 *   A query string to append to the link.
 * @param $fragment
 *   A fragment identifier (named anchor) to append to the link.
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
 *   Useful for links that will be displayed outside the site, such as in an RSS feed.
1011 1012
 * @param $html
 *   Whether the title is HTML, or just plain-text.
1013 1014 1015
 * @return
 *   an HTML string containing a link to the given path.
 */
1016
function l($text, $path, $attributes = array(), $query = NULL, $fragment = NULL, $absolute = FALSE, $html = FALSE) {
1017
  if ($path == $_GET['q']) {
1018 1019 1020 1021 1022 1023 1024
    if (isset($attributes['class'])) {
      $attributes['class'] .= ' active';
    }
    else {
      $attributes['class'] = 'active';
    }
  }
1025
  return '<a href="'. check_url(url($path, $query, $fragment, $absolute)) .'"'. drupal_attributes($attributes) .'>'. ($html ? $text : check_plain($text)) .'</a>';
1026 1027
}

1028 1029 1030 1031 1032 1033
/**
 * Perform end-of-request tasks.
 *
 * This function sets the page cache if appropriate, and allows modules to
 * react to the closing of the page by calling hook_exit().
 */
1034
function drupal_page_footer() {
1035
  if (variable_get('cache', 0)) {
1036
    page_set_cache();
Dries's avatar
Dries committed
1037
  }
1038

1039
  module_invoke_all('exit');
Dries's avatar
Dries committed
1040 1041
}