common.inc 90 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 165
  static $stored_feed_links = array();

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

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

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

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 209 210
/**
 * Parse an array into a valid urlencoded query string.
 *
 * @param $query
 *   The array to be processed e.g. $_GET
 * @param $exclude
 *   The array filled with keys to be excluded. Use parent[child] to exclude nested items.
 * @param $urlencode
 *   If TRUE, the keys and values are both urlencoded.
 * @param $parent
 *   Should not be passed, only used in recursive calls
 * @return
 *   urlencoded string which can be appended to/as the URL query string
 */
function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
  $params = array();

  foreach ($query as $key => $value) {
211
    $key = drupal_urlencode($key);
212
    if ($parent) {
213
      $key = $parent .'['. $key .']';
214 215
    }

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

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

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

231 232
/**
 * Prepare a destination query string for use in combination with
233 234 235
 * drupal_goto(). Used to direct the user back to the referring page
 * after completing a form. By default the current URL is returned.
 * If a destination exists in the previous request, that destination
236
 * is returned. As such, a destination can persist across multiple
237
 * pages.
238 239 240 241
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
242
  if (isset($_REQUEST['destination'])) {
243 244 245
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
246 247
    // Use $_GET here to retrieve the original path in source form.
    $path = isset($_GET['q']) ? $_GET['q'] : '';
248 249 250
    $query = drupal_query_string_encode($_GET, array('q'));
    if ($query != '') {
      $path .= '?'. $query;
251
    }
252
    return 'destination='. urlencode($path);
253 254 255
  }
}

Kjartan's avatar
Kjartan committed
256
/**
Dries's avatar
 
Dries committed
257
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
258
 *
Dries's avatar
 
Dries committed
259 260
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
261
 *
262
 * Usually the redirected URL is constructed from this function's input
263
 * parameters. However you may override that behavior by setting a
264 265
 * <em>destination</em> in either the $_REQUEST-array (i.e. by using
 * the query string of an URI) or the $_REQUEST['edit']-array (i.e. by
266 267
 * using a hidden form field). This is used to direct the user back to
 * the proper page after completing a form. For example, after editing
268
 * a post on the 'admin/content/node'-page or after having logged on using the
269
 * 'user login'-block in a sidebar. The function drupal_get_destination()
270 271
 * can be used to help set the destination URL.
 *
Dries's avatar
 
Dries committed
272 273 274 275 276 277 278 279
 * It is advised to use drupal_goto() instead of PHP's header(), because
 * drupal_goto() will append the user's session ID to the URI when PHP is
 * compiled with "--enable-trans-sid".
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
280
 *   A Drupal path or a full URL.
Dries's avatar
 
Dries committed
281 282 283 284
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
285 286 287 288 289 290 291 292 293 294 295
 * @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.
296
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
297
 */
298
function drupal_goto($path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) {
299
  if (isset($_REQUEST['destination'])) {
300
    extract(parse_url(urldecode($_REQUEST['destination'])));
301
  }
302
  else if (isset($_REQUEST['edit']['destination'])) {
303
    extract(parse_url(urldecode($_REQUEST['edit']['destination'])));
304 305
  }

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

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

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

Dries's avatar
 
Dries committed
313 314 315
  // 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
316 317 318
  exit();
}

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

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

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

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

Dries's avatar
 
Dries committed
342
  $path = drupal_get_normal_path(variable_get('site_404', ''));
drumm's avatar
drumm committed
343
  if ($path && $path != $_GET['q']) {
Dries's avatar
 
Dries committed
344
    menu_set_active_item($path);
345
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
346
  }
347
  else {
348
    // Redirect to a non-existent menu item to make possible tabs disappear.
349
    menu_set_active_item('');
350
  }
Dries's avatar
 
Dries committed
351

drumm's avatar
drumm committed
352 353
  if (empty($return)) {
    drupal_set_title(t('Page not found'));
354
    $return = '';
Dries's avatar
 
Dries committed
355
  }
356 357
  // To conserve CPU and bandwidth, omit the blocks
  print theme('page', $return, FALSE);
Dries's avatar
 
Dries committed
358
}
Dries's avatar
 
Dries committed
359

Dries's avatar
 
Dries committed
360 361 362 363
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
364
  drupal_set_header('HTTP/1.1 403 Forbidden');
365
  watchdog('access denied', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
366

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

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

drumm's avatar
drumm committed
382 383 384
  if (empty($return)) {
    drupal_set_title(t('Access denied'));
    $return = t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
385
  }
386
  print theme('page', $return);
Dries's avatar
 
Dries committed
387 388
}

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

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

Dries's avatar
 
Dries committed
432
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
433
  if (!$fp) {
434 435 436 437
    // 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
438 439 440
    return $result;
  }

Dries's avatar
 
Dries committed
441
  // Construct the path to act on.
Dries's avatar
Dries committed
442 443
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
 
Dries committed
444
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
445 446
  }

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

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
458
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
459 460
  }

461
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
462 463 464
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
465
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
466 467 468 469 470 471
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
472
  $response = '';
473 474
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries's avatar
 
Dries committed
475 476 477 478
  }
  fclose($fp);

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

482
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries's avatar
 
Dries committed
483 484 485
  $result->headers = array();

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

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

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

Dries's avatar
Dries committed
550
  if ($errno & (E_ALL)) {
Dries's avatar
 
Dries committed
551 552
    $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 .'.';
Dries's avatar
 
Dries committed
553

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

559
    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
560 561 562
  }
}

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

572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
/**
 * 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
590 591 592 593
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
594
function fix_gpc_magic() {
595
  static $fixed = FALSE;
Dries's avatar
 
Dries committed
596
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
597 598 599 600
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
601
    array_walk($_FILES, '_fix_gpc_magic_files');
602
    $fixed = TRUE;
Dries's avatar
Dries committed
603
  }
Dries's avatar
 
Dries committed
604 605
}

Kjartan's avatar
Kjartan committed
606
/**
607
 * Translate strings to the page language or a given language.
Kjartan's avatar
Kjartan committed
608
 *
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
 * 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
629
 * can also be used for text that may change from time to time
630 631 632 633 634 635 636 637 638 639 640 641 642
 * (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
643
 *     $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))));
644 645 646 647 648 649 650 651 652 653 654 655
 *   @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
656
 *     $message = t('%name-from sent %name-to an e-mail.', array('%name-from' => $user->name, '%name-to' => $account->name));
657 658
 *   @endcode
 *
659
 * When using t(), try to put entire sentences and strings in one t() call.
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
 * 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
684
 * @code
685
 *   $output .= t("Don't click me.");
Dries's avatar
 
Dries committed
686
 * @endcode
Kjartan's avatar
Kjartan committed
687
 *
Dries's avatar
 
Dries committed
688
 * @param $string
Dries's avatar
 
Dries committed
689
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
690 691
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
692
 *   of any key in this array are replaced with the corresponding value.
693 694 695 696 697
 *   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)
698 699 700
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
Dries's avatar
 
Dries committed
701 702
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
703
 */
704
function t($string, $args = 0, $langcode = NULL) {
705
  global $language;
706 707
  static $custom_strings;

708 709
  $langcode = isset($langcode) ? $langcode : $language->language;

710 711 712 713
  // 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.
714 715
  if (!isset($custom_strings[$langcode])) {
    $custom_strings[$langcode] = variable_get('locale_custom_strings_'. $langcode, array());
716 717
  }
  // Custom strings work for English too, even if locale module is disabled.
718 719
  if (isset($custom_strings[$langcode][$string])) {
    $string = $custom_strings[$langcode][$string];
720 721
  }
  // Translate with locale module if enabled.
722 723
  elseif (function_exists('locale') && $langcode != 'en') {
    $string = locale($string, $langcode);
Dries's avatar
 
Dries committed
724
  }
Dries's avatar
 
Dries committed
725 726
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
727 728
  }
  else {
729
    // Transform arguments before inserting them
730
    foreach ($args as $key => $value) {
731 732 733 734 735 736 737 738 739 740 741 742 743 744
      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
745 746
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
747 748
}

Kjartan's avatar
Kjartan committed
749
/**
Dries's avatar
 
Dries committed
750
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
751
 * @{
Dries's avatar
 
Dries committed
752
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
753 754
 */

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

Dries's avatar
 
Dries committed
774 775 776
/**
 * Verify the syntax of the given URL.
 *
777 778 779
 * 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
780
 * @param $url
Dries's avatar
 
Dries committed
781
 *   The URL to verify.
Dries's avatar
 
Dries committed
782
 * @param $absolute
Dries's avatar
 
Dries committed
783
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
 
Dries committed
784
 * @return
Dries's avatar
 
Dries committed
785
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
786
 */
Dries's avatar
 
Dries committed
787
function valid_url($url, $absolute = FALSE) {
788
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,;~=#&%\+]';
789
  if ($absolute) {
790
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
791 792
  }
  else {
793
    return preg_match("/^". $allowed_characters ."+$/i", $url);
794
  }
Dries's avatar
 
Dries committed
795 796
}

Dries's avatar
 
Dries committed
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
/**
 * 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
817
 *   True if the user did not exceed the hourly threshold. False otherwise.
Dries's avatar
 
Dries committed
818 819 820 821 822 823
 */
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);
}

824 825
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
826 827
}

Dries's avatar
Dries committed
828 829 830 831 832
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
833
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
834 835
}

Dries's avatar
 
Dries committed
836
/**
Dries's avatar
 
Dries committed
837
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
838
 * @{
Dries's avatar
 
Dries committed
839
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
840 841
 */

Dries's avatar
 
Dries committed
842 843 844 845 846 847
/**
 * 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
848 849
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
850
  $output = "<channel>\n";
851 852
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
853 854 855 856 857

  // 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";
858
  $output .= ' <language>'. check_plain($language) ."</language>\n";
859
  $output .= format_xml_elements($args);
Dries's avatar
 
Dries committed
860 861 862 863 864 865
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

906
        if ($value['value'] != '') {
907
          $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
Dries's avatar
 
Dries committed
908 909 910 911 912 913 914
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
915
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
916
    }
Dries's avatar
 
Dries committed
917
  }
Dries's avatar
 
Dries committed
918 919 920
  return $output;
}

Dries's avatar
 
Dries committed
921
/**
Dries's avatar
 
Dries committed
922
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
923
 *
Dries's avatar
 
Dries committed
924 925 926
 * 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.
 *
927 928 929 930 931 932 933 934 935 936 937 938 939
 * 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
940 941 942 943 944
 * @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").
945
 *   Do not use @count in the singluar string.
Dries's avatar
 
Dries committed
946 947
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
948
 *   to ease translation. Use @count in place of the item count, as in "@count
Dries's avatar
 
Dries committed
949
 *   new comments".
950 951 952 953 954 955 956 957 958 959
 * @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.
Dries's avatar
 
Dries committed
960 961
 * @return
 *   A translated string.
Dries's avatar
 
Dries committed
962
 */
963 964 965 966 967
function format_plural($count, $singular, $plural, $args = array()) {
  if ($count == 1) {
    return t($singular, $args);
  }
  $args['@count'] = $count;
Dries's avatar
 
Dries committed
968 969

  // get the plural index through the gettext formula
970
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
 
Dries committed
971
  if ($index < 0) { // backward compatibility
972
    return t($plural, $args);
Dries's avatar
 
Dries committed
973 974 975 976
  }
  else {
    switch ($index) {
      case "0":
977
        return t($singular, $args);
Dries's avatar
 
Dries committed
978
      case "1":
979
        return t($plural, $args);
Dries's avatar
 
Dries committed
980
      default:
981 982 983
        unset($args['@count']);
        $args['@count['. $index .']'] = $count;
        return t(strtr($plural, array('@count' => '@count['. $index .']')), $args);
Dries's avatar
 
Dries committed
984 985
    }
  }
Dries's avatar
 
Dries committed
986 987
}

988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
/**
 * 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
1009
/**
Dries's avatar
 
Dries committed
1010
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
1011
 *
Dries's avatar
 
Dries committed
1012 1013 1014 1015
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
1016
 */
Dries's avatar
 
Dries committed
1017
function format_size($size) {
1018 1019
  if ($size < 1024) {
    return format_plural($size, '1 byte', '@count bytes');
Dries's avatar
 
Dries committed
1020
  }
1021
  else {
Dries's avatar
 
Dries committed
1022
    $size = round($size / 1024, 2);
1023 1024 1025 1026 1027 1028
    $suffix = t('KB');
    if ($size >= 1024) {
      $size = round($size / 1024, 2);
      $suffix = t('MB');
    }
    return t('@size @suffix', array('@size' => $size, '@suffix' => $suffix));
Dries's avatar
 
Dries committed
1029 1030 1031
  }
}

Dries's avatar
 
Dries committed
1032
/**
Dries's avatar
 
Dries committed
1033
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
1034
 *
Dries's avatar
 
Dries committed
1035 1036 1037 1038 1039 1040
 * @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.
Dries's avatar
 
Dries committed
1041
 */
Dries's avatar
 
Dries committed
1042
function format_interval($timestamp, $granularity = 2) {
1043
  $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
1044
  $output = '';
Dries's avatar
 
Dries committed
1045
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
1046
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
1047
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
1048
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
1049
      $timestamp %= $value;
Dries's avatar
 
Dries committed
1050 1051 1052 1053 1054
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
1055 1056
    }
  }
Dries's avatar
 
Dries committed
1057
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
1058 1059
}

Dries's avatar
 
Dries committed
1060
/**
Dries's avatar
 
Dries committed
1061 1062
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
1063 1064 1065 1066
 * 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
1067 1068 1069 1070 1071 1072
 * @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
1073 1074 1075
 *   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
1076 1077 1078 1079
 * @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.
Dries's avatar
 
Dries committed
1080
 */
1081
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
1082
  if (!isset($timezone)) {
1083
    global $user;
Steven Wittens's avatar
Steven Wittens committed
1084 1085 1086 1087 1088 1089
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
1090
  }
Dries's avatar
 
Dries committed
1091

1092
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
1093 1094

  switch ($type) {
1095 1096
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
1097
      break;
1098 1099
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
1100
      break;
1101
    case 'custom':
Dries's avatar
 
Dries committed
1102
      // No change to format
Dries's avatar
 
Dries committed
1103
      break;
1104
    case 'medium':
Dries's avatar
 
Dries committed
1105
    default:
1106
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
1107 1108
  }

1109
  $max = strlen($format);
Dries's avatar
 
Dries committed
1110
  $date = '';
Dries's avatar
 
Dries committed
1111
  for ($i = 0; $i < $max; $i++) {
1112
    $c = $format[$i];
1113
    if (strpos('AaDFlM', $c) !== FALSE) {
1114
      $date .= t(gmdate($c, $timestamp));
1115
    }
1116
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== FALSE) {
1117 1118 1119 1120
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries's avatar
 
Dries committed
1121
    }
1122 1123 1124 1125 1126
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
Dries's avatar
 
Dries committed
1127
    }
1128 1129 1130
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
 
Dries committed
1131
    else {
1132
      $date .= $c;
Dries's avatar
 
Dries committed
1133
    }
Dries's avatar
 
Dries committed