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

Dries's avatar
 
Dries committed
4 5 6 7 8 9 10 11
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/**
 * Return status for saving which involved creating a new item.
 */
define('SAVED_NEW', 1);

/**
 * Return status for saving which involved an update to an existing item.
 */
define('SAVED_UPDATED', 2);

/**
 * Return status for saving which deleted an existing item.
 */
define('SAVED_DELETED', 3);

27 28 29 30 31 32 33 34 35
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
36
function drupal_set_content($region = NULL, $data = NULL) {
37 38 39 40 41 42 43 44 45 46 47 48
  static $content = array();

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

/**
 * Get assigned content.
 *
 * @param $region
49
 *   A specified region to fetch content for. If NULL, all regions will be returned.
50 51 52 53
 *
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
54
function drupal_get_content($region = NULL, $delimiter = ' ') {
55
  $content = drupal_set_content();
56 57
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
58
      return implode($delimiter, $content[$region]);
59
    }
60 61 62 63
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
64
        $content[$region] = implode($delimiter, $content[$region]);
65 66 67 68 69 70
      }
    }
    return $content;
  }
}

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

81
  if (!is_null($breadcrumb)) {
Dries's avatar
 
Dries committed
82 83 84 85 86
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

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

93
  if (is_null($breadcrumb)) {
Dries's avatar
 
Dries committed
94 95 96 97 98 99
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
100
/**
Dries's avatar
 
Dries committed
101
 * Add output to the head tag of the HTML page.
Dries's avatar
 
Dries committed
102
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
103 104
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
 
Dries committed
105
  static $stored_head = '';
Dries's avatar
Dries committed
106 107

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

Dries's avatar
 
Dries committed
113 114 115
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
116
function drupal_get_html_head() {
Dries's avatar
 
Dries committed
117
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
118 119 120
  return $output . drupal_set_html_head();
}

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

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

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

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

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

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

    drupal_add_link(array('rel' => 'alternate',
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
  }
  return $stored_feed_links;
}

/**
 * Get the feed URLs for the current page.
 *
 * @param $delimiter
 *   The delimiter to split feeds by
 */
function drupal_get_feeds($delimiter = "\n") {
  $feeds = drupal_add_feed();
  return implode($feeds, $delimiter);
}

Dries's avatar
 
Dries committed
187 188 189
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
190
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
191 192
 */

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

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

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

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

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

Kjartan's avatar
Kjartan committed
254
/**
Dries's avatar
 
Dries committed
255
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
256
 *
Dries's avatar
 
Dries committed
257 258
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
259
 *
260
 * Usually the redirected URL is constructed from this function's input
261
 * parameters. However you may override that behavior by setting a
262 263
 * <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
264 265
 * 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
266
 * a post on the 'admin/content/node'-page or after having logged on using the
267
 * 'user login'-block in a sidebar. The function drupal_get_destination()
268 269
 * can be used to help set the destination URL.
 *
Dries's avatar
 
Dries committed
270 271 272 273 274 275 276 277
 * 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
278
 *   A Drupal path or a full URL.
Dries's avatar
 
Dries committed
279 280 281 282
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
283 284 285 286 287 288 289 290 291 292 293
 * @param $http_response_code
 *   Valid values for an actual "goto" as per RFC 2616 section 10.3 are:
 *   - 301 Moved Permanently (the recommended value for most redirects)
 *   - 302 Found (default in Drupal and PHP, sometimes used for spamming search
 *         engines)
 *   - 303 See Other
 *   - 304 Not Modified
 *   - 305 Use Proxy
 *   - 307 Temporary Redirect (an alternative to "503 Site Down for Maintenance")
 *   Note: Other values are defined by RFC 2616, but are rarely used and poorly
 *         supported.
294
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
295
 */
296
function drupal_goto($path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) {
297
  if (isset($_REQUEST['destination'])) {
298
    extract(parse_url(urldecode($_REQUEST['destination'])));
299
  }
300
  else if (isset($_REQUEST['edit']['destination'])) {
301
    extract(parse_url(urldecode($_REQUEST['edit']['destination'])));
302 303
  }

304
  $url = url($path, array('query' => $query, 'fragment' => $fragment, 'absolute' => TRUE));
Kjartan's avatar
Kjartan committed
305

Dries's avatar
 
Dries committed
306 307 308
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

309
  header('Location: '. $url, TRUE, $http_response_code);
Kjartan's avatar
Kjartan committed
310

Dries's avatar
 
Dries committed
311 312 313
  // The "Location" header sends a REDIRECT status code to the http
  // daemon. In some cases this can go wrong, so we make sure none
  // of the code below the drupal_goto() call gets executed when we redirect.
Kjartan's avatar
Kjartan committed
314 315 316
  exit();
}

317
/**
318
 * Generates a site off-line message
319 320
 */
function drupal_site_offline() {
321
  drupal_maintenance_theme();
322
  drupal_set_header('HTTP/1.1 503 Service unavailable');
323
  drupal_set_title(t('Site off-line'));
324
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
325
    t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal'))))));
326 327
}

Kjartan's avatar
Kjartan committed
328 329 330
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
331
function drupal_not_found() {
332
  drupal_set_header('HTTP/1.1 404 Not Found');
333

334
  watchdog('page not found', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
335

336 337 338 339 340
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
 
Dries committed
341
  $path = drupal_get_normal_path(variable_get('site_404', ''));
drumm's avatar
drumm committed
342
  if ($path && $path != $_GET['q']) {
343
    $return = menu_execute_active_handler($path);
344
  }
Dries's avatar
 
Dries committed
345

drumm's avatar
drumm committed
346 347
  if (empty($return)) {
    drupal_set_title(t('Page not found'));
348
    $return = '';
Dries's avatar
 
Dries committed
349
  }
350 351
  // To conserve CPU and bandwidth, omit the blocks
  print theme('page', $return, FALSE);
Dries's avatar
 
Dries committed
352
}
Dries's avatar
 
Dries committed
353

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

drumm's avatar
drumm committed
361
// Keep old path for reference
362 363 364 365
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries's avatar
 
Dries committed
366
  $path = drupal_get_normal_path(variable_get('site_403', ''));
drumm's avatar
drumm committed
367
  if ($path && $path != $_GET['q']) {
368
    $return = menu_execute_active_handler($path);
369
  }
Dries's avatar
 
Dries committed
370

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

Dries's avatar
 
Dries committed
378
/**
Dries's avatar
 
Dries committed
379
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
380
 *
Dries's avatar
 
Dries committed
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
 * This is a flexible and powerful HTTP client implementation. Correctly handles
 * GET, POST, PUT or any other HTTP requests. Handles redirects.
 *
 * @param $url
 *   A string containing a fully qualified URI.
 * @param $headers
 *   An array containing an HTTP header => value pair.
 * @param $method
 *   A string defining the HTTP request to use.
 * @param $data
 *   A string containing data to include in the request.
 * @param $retry
 *   An integer representing how many times to retry the request in case of a
 *   redirect.
 * @return
 *   An object containing the HTTP request headers, response code, headers,
 *   data, and redirect status.
Dries's avatar
 
Dries committed
398 399
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
400
  $result = new stdClass();
Dries's avatar
 
Dries committed
401

Dries's avatar
 
Dries committed
402
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
403
  $uri = parse_url($url);
404

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

Dries's avatar
 
Dries committed
422
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
423
  if (!$fp) {
424 425 426 427
    // When a network error occurs, we make sure that it is a negative
    // number so it can clash with the HTTP status codes.
    $result->code = -$errno;
    $result->error = trim($errstr);
Dries's avatar
 
Dries committed
428 429 430
    return $result;
  }

Dries's avatar
 
Dries committed
431
  // Construct the path to act on.
Dries's avatar
Dries committed
432 433
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
 
Dries committed
434
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
435 436
  }

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

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
448
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
449 450
  }

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

  fwrite($fp, $request);

  // Fetch response.
462
  $response = '';
463 464
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
 
Dries committed
465 466 467 468
  }
  fclose($fp);

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

472
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
 
Dries committed
473 474 475
  $result->headers = array();

  // Parse headers.
476
  while ($line = trim(array_shift($split))) {
Dries's avatar
 
Dries committed
477
    list($header, $value) = explode(':', $line, 2);
478 479 480 481 482 483 484 485
    if (isset($result->headers[$header]) && $header == 'Set-Cookie') {
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
      $result->headers[$header] .= ','. trim($value);
    }
    else {
      $result->headers[$header] = trim($value);
    }
Dries's avatar
 
Dries committed
486 487 488 489 490 491 492 493 494 495
  }

  $responses = array(
    100 => 'Continue', 101 => 'Switching Protocols',
    200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content',
    300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect',
    400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed',
    500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported'
  );
  // RFC 2616 states that all unknown HTTP codes must be treated the same as
Dries's avatar
 
Dries committed
496
  // the base code in their class.
Dries's avatar
 
Dries committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
      $location = $result->headers['Location'];

      if ($retry) {
        $result = drupal_http_request($result->headers['Location'], $headers, $method, $data, --$retry);
        $result->redirect_code = $result->code;
      }
      $result->redirect_url = $location;

      break;
    default:
      $result->error = $text;
  }

  $result->code = $code;
  return $result;
}
Dries's avatar
 
Dries committed
524 525 526
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
527

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

Dries's avatar
Dries committed
540
  if ($errno & (E_ALL)) {
Dries's avatar
 
Dries committed
541
    $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');
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561

    // For database errors, we want the line number/file name of the place that
    // the query was originally called, not _db_query().
    if (isset($context[DB_ERROR])) {
      $backtrace = array_reverse(debug_backtrace());

      // List of functions where SQL queries can originate.
      $query_functions = array('db_query', 'pager_query', 'db_query_range', 'db_query_temporary', 'update_sql');

      // Determine where query function was called, and adjust line/file
      // accordingly.
      foreach ($backtrace as $index => $function) {
        if (in_array($function['function'], $query_functions)) {
          $line = $backtrace[$index]['line'];
          $filename = $backtrace[$index]['file'];
          break;
        }
      }
    }

Dries's avatar
 
Dries committed
562
    $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
 
Dries committed
563

564
    // Force display of error messages in update.php
565
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['PHP_SELF'], 'update.php')) {
566
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
567
    }
568

569
    watchdog('php', '%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line), WATCHDOG_ERROR);
Dries's avatar
 
Dries committed
570 571 572
  }
}

Dries's avatar
 
Dries committed
573
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
574
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
575 576 577
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
578
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
579 580 581
  }
}

582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
/**
 * 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);
    }
  }
}

Dries's avatar
 
Dries committed
600 601 602 603
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
604
function fix_gpc_magic() {
605
  static $fixed = FALSE;
Dries's avatar
 
Dries committed
606
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
607 608 609 610
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
611
    array_walk($_FILES, '_fix_gpc_magic_files');
612
    $fixed = TRUE;
Dries's avatar
Dries committed
613
  }
Dries's avatar
 
Dries committed
614 615
}

Kjartan's avatar
Kjartan committed
616
/**
617
 * Translate strings to the page language or a given language.
Kjartan's avatar
Kjartan committed
618
 *
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
 * All human-readable text that will be displayed somewhere within a page should be
 * run through the t() function.
 *
 * Examples:
 * @code
 *   if (!$info || !$info['extension']) {
 *     form_set_error('picture_upload', t('The uploaded file was not an image.'));
 *   }
 *
 *   $form['submit'] = array(
 *     '#type' => 'submit',
 *     '#value' => t('Log in'),
 *   );
 * @endcode
 *
 * Any text within t() can be extracted by translators and changed into
 * the equivalent text in their native language.
 *
 * Special variables called "placeholders" are used to signal dynamic
 * information in a string which should not be translated. Placeholders
drumm's avatar
drumm committed
639
 * can also be used for text that may change from time to time
640 641 642 643 644 645 646 647 648 649 650 651 652
 * (such as link paths) to be changed without requiring updates to translations.
 *
 * For example:
 * @code
 *   $output = t('There are currently %members and %visitors online.', array(
 *     '%members' => format_plural($total_users, '1 user', '@count users'),
 *     '%visitors' => format_plural($guests->count, '1 guest', '@count guests')));
 * @endcode
 *
 * There are three styles of placeholders:
 * - !variable, which indicates that the text should be inserted as-is. This is
 *   useful for inserting variables into things like e-mail.
 *   @code
653
 *     $message[] = t("If you don't want to receive such e-mails, you can change your settings at !url.", array('!url' => url("user/$account->uid", array('absolute' => TRUE))));
654 655 656 657 658 659 660 661 662 663 664 665
 *   @endcode
 *
 * - @variable, which indicates that the text should be run through check_plain,
 *   to strip out HTML characters. Use this for any output that's displayed within
 *   a Drupal page.
 *   @code
 *     drupal_set_title($title = t("@name's blog", array('@name' => $account->name)));
 *   @endcode
 *
 * - %variable, which indicates that the string should be highlighted with
 *   theme_placeholder() which shows up by default as <em>emphasized</em>.
 *   @code
666
 *     $message = t('%name-from sent %name-to an e-mail.', array('%name-from' => $user->name, '%name-to' => $account->name));
667 668
 *   @endcode
 *
669
 * When using t(), try to put entire sentences and strings in one t() call.
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
 * This makes it easier for translators, as it provides context as to what
 * each word refers to. HTML markup within translation strings is allowed,
 * but should be avoided if possible. The exception is embedded links; link
 * titles add additional context for translators so should be kept in the main
 * string.
 *
 * Here is an example of an incorrect use if t():
 * @code
 *   $output .= t('<p>Go to the @contact-page.</p>', array('@contact-page' => l(t('contact page'), 'contact')));
 * @endcode
 *
 * Here is an example of t() used correctly:
 * @code
 *   $output .= '<p>'. t('Go to the <a href="@contact-page">contact page</a>.', array('@contact-page' => url('contact'))) .'</p>';
 * @endcode
 *
 * Also avoid escaping quotation marks wherever possible.
 *
 * Incorrect:
 * @code
 *   $output .= t('Don\'t click me.');
 * @endcode
 *
 * Correct:
Dries's avatar
 
Dries committed
694
 * @code
695
 *   $output .= t("Don't click me.");
Dries's avatar
 
Dries committed
696
 * @endcode
Kjartan's avatar
Kjartan committed
697
 *
Dries's avatar
 
Dries committed
698
 * @param $string
Dries's avatar
 
Dries committed
699
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
700 701
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
702
 *   of any key in this array are replaced with the corresponding value.
703 704 705 706 707
 *   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)
708 709 710
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
Dries's avatar
 
Dries committed
711 712
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
713
 */
714
function t($string, $args = array(), $langcode = NULL) {
715
  global $language;
716 717
  static $custom_strings;

718 719
  $langcode = isset($langcode) ? $langcode : $language->language;

720 721 722 723
  // First, check for an array of customized strings. If present, use the array
  // *instead of* database lookups. This is a high performance way to provide a
  // handful of string replacements. See settings.php for examples.
  // Cache the $custom_strings variable to improve performance.
724 725
  if (!isset($custom_strings[$langcode])) {
    $custom_strings[$langcode] = variable_get('locale_custom_strings_'. $langcode, array());
726 727
  }
  // Custom strings work for English too, even if locale module is disabled.
728 729
  if (isset($custom_strings[$langcode][$string])) {
    $string = $custom_strings[$langcode][$string];
730 731
  }
  // Translate with locale module if enabled.
732 733
  elseif (function_exists('locale') && $langcode != 'en') {
    $string = locale($string, $langcode);
Dries's avatar
 
Dries committed
734
  }
735
  if (empty($args)) {
Dries's avatar
 
Dries committed
736
    return $string;
Kjartan's avatar
Kjartan committed
737 738
  }
  else {
739
    // Transform arguments before inserting them
740
    foreach ($args as $key => $value) {
741 742 743 744 745 746 747 748 749 750 751 752 753 754
      switch ($key[0]) {
        // Escaped only
        case '@':
          $args[$key] = check_plain($value);
        break;
        // Escaped and placeholder
        case '%':
        default:
          $args[$key] = theme('placeholder', $value);
          break;
        // Pass-through
        case '!':
      }
    }
Dries's avatar
 
Dries committed
755 756
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
757 758
}

Kjartan's avatar
Kjartan committed
759
/**
Dries's avatar
 
Dries committed
760
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
761
 * @{
Dries's avatar
 
Dries committed
762
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
763 764
 */

765
/**
Dries's avatar
 
Dries committed
766 767 768
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
769
 *
Dries's avatar
 
Dries committed
770
 * @param $mail
771
 *   A string containing an e-mail address.
Dries's avatar
 
Dries committed
772
 * @return
Dries's avatar
 
Dries committed
773
 *   TRUE if the address is in a valid format.
774
 */
Dries's avatar
 
Dries committed
775
function valid_email_address($mail) {
776
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
777
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
778 779 780
  $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
781
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
782 783
}

Dries's avatar
 
Dries committed
784 785 786
/**
 * Verify the syntax of the given URL.
 *
787 788 789
 * This function should only be used on actual URLs. It should not be used for
 * Drupal menu paths, which can contain arbitrary characters.
 *
Dries's avatar
 
Dries committed
790
 * @param $url
Dries's avatar
 
Dries committed
791
 *   The URL to verify.
Dries's avatar
 
Dries committed
792
 * @param $absolute
Dries's avatar
 
Dries committed
793
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
 
Dries committed
794
 * @return
Dries's avatar
 
Dries committed
795
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
796
 */
Dries's avatar
 
Dries committed
797
function valid_url($url, $absolute = FALSE) {
798
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,;~=#&%\+]';
799
  if ($absolute) {
800
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
801 802
  }
  else {
803
    return preg_match("/^". $allowed_characters ."+$/i", $url);
804
  }
Dries's avatar
 
Dries committed
805 806
}

Dries's avatar
 
Dries committed
807 808 809 810 811 812 813
/**
 * 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) {
814
  db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, ip_address(), time());
Dries's avatar
 
Dries committed
815 816 817 818 819 820 821 822 823 824 825 826
}

/**
 * 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
827
 *   True if the user did not exceed the hourly threshold. False otherwise.
Dries's avatar
 
Dries committed
828 829
 */
function flood_is_allowed($name, $threshold) {
830
  $number = db_result(db_query("SELECT COUNT(*) FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, ip_address(), time() - 3600));
Dries's avatar
 
Dries committed
831 832 833
  return ($number < $threshold ? TRUE : FALSE);
}

834 835
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
836 837
}

Dries's avatar
Dries committed
838 839 840 841 842
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
843
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
844 845
}

Dries's avatar
 
Dries committed
846
/**
Dries's avatar
 
Dries committed
847
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
848
 * @{
Dries's avatar
 
Dries committed
849
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
850 851
 */

Dries's avatar
 
Dries committed
852 853 854 855 856
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
857 858 859
function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
  global $language;
  $langcode = $langcode ? $langcode : $language->language;
Dries's avatar
 
Dries committed
860

Dries's avatar
Dries committed
861
  $output = "<channel>\n";
862 863
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
864 865 866 867 868

  // 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";
869
  $output .= ' <language>'. check_plain($langcode) ."</language>\n";
870
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
871 872 873 874 875 876
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
877 878 879 880 881
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
882
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
883
  $output = "<item>\n";
884 885 886
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
  $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) {
908
  $output = '';
909 910
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
911 912
      if ($value['key']) {
        $output .= ' <'. $value['key'];
913
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
 
Dries committed
914 915 916
          $output .= drupal_attributes($value['attributes']);
        }

917
        if ($value['value'] != '') {
918
          $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
Dries's avatar
 
Dries committed
919 920 921 922 923 924 925
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
926
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
927
    }
Dries's avatar
 
Dries committed
928
  }
Dries's avatar
 
Dries committed
929 930 931
  return $output;
}

Dries's avatar
 
Dries committed
932
/**
Dries's avatar
 
Dries committed
933
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
934
 *
Dries's avatar
 
Dries committed
935 936 937
 * 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.
 *
938 939 940 941 942 943 944 945 946 947 948 949 950
 * For example:
 * @code
 *   $output = format_plural($node->comment_count, '1 comment', '@count comments');
 * @endcode
 *
 * Example with additional replacements:
 * @code
 *   $output = format_plural($update_count,
 *     'Changed the content type of 1 post from %old-type to %new-type.',
 *     'Changed the content type of @count posts from %old-type to %new-type.',
 *     array('%old-type' => $info->old_type, '%new-type' => $info->new_type)));
 * @endcode
 *
Dries's avatar
 
Dries committed
951 952 953 954 955
 * @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").
Dries's avatar
Dries committed
956
 *   Do not use @count in the singular string.
Dries's avatar
 
Dries committed
957 958
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
959
 *   to ease translation. Use @count in place of the item count, as in "@count
Dries's avatar
 
Dries committed
960
 *   new comments".
961 962 963 964 965 966 967 968 969 970
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
 *   of any key in this array are replaced with the corresponding value.
 *   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)
 *   Note that you do not need to include @count in this array.
 *   This replacement is done automatically for the plural case.
971 972 973
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
Dries's avatar
 
Dries committed
974 975
 * @return
 *   A translated string.
Dries's avatar
 
Dries committed
976
 */
977
function format_plural($count, $singular, $plural, $args = array(), $langcode = NULL) {
978
  $args['@count'] = $count;
979
  if ($count == 1) {
980
    return t($singular, $args, $langcode);
981
  }
Dries's avatar
 
Dries committed
982 983

  // get the plural index through the gettext formula
984
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, $langcode) : -1;
Dries's avatar
 
Dries committed
985
  if ($index < 0) { // backward compatibility
986
    return t($plural, $args, $langcode);
Dries's avatar
 
Dries committed
987 988 989 990
  }
  else {
    switch ($index) {
      case "0":
991
        return t($singular, $args, $langcode);
Dries's avatar
 
Dries committed
992
      case "1":
993
        return t($plural, $args, $langcode);
Dries's avatar
 
Dries committed
994
      default:
995 996
        unset($args['@count']);
        $args['@count['. $index .']'] = $count;
997
        return t(strtr($plural, array('@count' => '@count['. $index .']')), $args, $langcode);
Dries's avatar
 
Dries committed
998 999
    }
  }
Dries's avatar
 
Dries committed
1000 1001
}

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
/**
 * Parse a given byte count.
 *
 * @param $size
 *   The size expressed as a number of bytes with optional SI size and unit
 *   suffix (e.g. 2, 3K, 5MB, 10G).
 * @return
 *   An integer representation of the size.
 */
function parse_size($size) {
  $suffixes = array(
    '' => 1,
    'k' => 1024,
    'm' => 1048576, // 1024 * 1024
    'g' => 1073741824, // 1024 * 1024 * 1024
  );
  if (preg_match('/([0-9]+)\s*(k|m|g)?(b?(ytes?)?)/i', $size, $match)) {
    return $match[1] * $suffixes[drupal_strtolower($match[2])];
  }
}

Dries's avatar
 
Dries committed
1023
/**
Dries's avatar
 
Dries committed
1024
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
1025
 *
Dries's avatar
 
Dries committed
1026 1027
 * @param $size
 *   The size in bytes.
1028 1029 1030
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
Dries's avatar
 
Dries committed
1031 1032
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
1033
 */
1034
function format_size($size, $langcode = NULL) {
1035
  if ($size < 1024) {
1036
    return format_plural($size, '1 byte', '@count bytes', array(), $langcode);
Dries's avatar
 
Dries committed
1037
  }
1038
  else {
Dries's avatar
 
Dries committed
1039
    $size = round($size / 1024, 2);
1040
    $suffix = t('KB', array(), $langcode);
1041 1042
    if ($size >= 1024) {
      $size = round($size / 1024, 2);
1043
      $suffix = t('MB', array(), $langcode);
1044
    }
1045
    return t('@size @suffix', array('@size' => $size, '@suffix' => $suffix), $langcode);
Dries's avatar
 
Dries committed
1046 1047 1048
  }
}

Dries's avatar
 
Dries committed
1049
/**
Dries's avatar
 
Dries committed
1050
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
1051
 *
Dries's avatar
 
Dries committed
1052 1053 1054 1055
 * @param $timestamp
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
1056 1057 1058
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
Dries's avatar
 
Dries committed
1059 1060
 * @return
 *   A translated string representation of the interval.
Dries's avatar
 
Dries committed
1061
 */
1062
function format_interval($timestamp, $granularity = 2, $langcode = NULL) {
1063
  $units = array('1 year|@count years' => 31536000, '1 week|@count weeks' => 604800, '1 day|@count days' => 86400, '1 hour|@count hours' => 3600, '1 min|@count min' => 60, '1 sec|@count sec' => 1);
Dries's avatar
 
Dries committed
1064
  $output = '';
Dries's avatar
 
Dries committed
1065
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
1066
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
1067
    if ($timestamp >= $value) {
1068
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1], array(), $langcode);
Dries's avatar
 
Dries committed
1069
      $timestamp %= $value;
Dries's avatar
 
Dries committed
1070 1071 1072 1073 1074
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
1075 1076
    }
  }
1077
  return $output ? $output : t('0 sec', array(), $langcode);
Dries's avatar
 
Dries committed
1078 1079
}

Dries's avatar
 
Dries committed
1080
/**
Dries's avatar
 
Dries committed
1081 1082
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
1083 1084 1085 1086
 * Drupal allows administrators to select formatting strings for 'small',
 * 'medium' and 'large' date formats. This function can handle these formats,
 * as well as any custom format.
 *
Dries's avatar
 
Dries committed
1087 1088 1089 1090 1091 1092
 * @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
1093 1094 1095
 *   A PHP date format string as required by date(). A backslash should be used
 *   before a character to avoid interpreting the character as part of a date
 *   format.
Dries's avatar
 
Dries committed
1096 1097
 * @param $timezone
 *   Time zone offset in seconds; if omitted, the user's time zone is used.
1098 1099 1100
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
Dries's avatar
 
Dries committed
1101 1102
 * @return
 *   A translated date string in the requested format.
Dries's avatar
 
Dries committed
1103
 */
1104
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
1105
  if (!isset($timezone)) {
1106
    global $user;
Steven Wittens's avatar
Steven Wittens committed
1107 1108 1109 1110 1111 1112
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
1113
  }
Dries's avatar
 
Dries committed
1114

1115
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
1116 1117

  switch ($type) {
1118 1119
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
1120
      break;
1121 1122
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
1123
      break;
1124
    case 'custom':
Dries's avatar
 
Dries committed
1125
      // No change to format
Dries's avatar
 
Dries committed
1126
      break;
1127