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

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

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

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

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

  return $breadcrumb;
}

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

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

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

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

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

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

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

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

  if (!is_null($url)) {
163
164
165
166
167
168
    $stored_feed_links[$url] = theme('feed_icon', $url);

    drupal_add_link(array('rel' => 'alternate',
                          'type' => 'application/rss+xml',
                          'title' => $title,
                          'href' => $url));
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
  }
  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 Buytaert's avatar
   
Dries Buytaert committed
184
185
186
/**
 * @name HTTP handling
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
187
 * Functions to properly handle HTTP responses.
Dries Buytaert's avatar
   
Dries Buytaert committed
188
189
 */

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

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

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

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

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

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

293
  $url = url($path, $query, $fragment, TRUE);
294

Dries Buytaert's avatar
   
Dries Buytaert committed
295
296
297
298
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

Dries Buytaert's avatar
   
Dries Buytaert committed
300
301
302
  // 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.
303
304
305
  exit();
}

306
/**
307
 * Generates a site off-line message
308
309
 */
function drupal_site_offline() {
310
  drupal_set_header('HTTP/1.0 503 Service unavailable');
311
  drupal_set_title(t('Site off-line'));
312
  print theme('maintenance_page', filter_xss_admin(variable_get('site_offline_message',
313
    t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', t('This Drupal site')))))));
314
315
}

316
317
318
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
319
function drupal_not_found() {
320
  drupal_set_header('HTTP/1.0 404 Not Found');
321
  watchdog('page not found', t('%page not found.', array('%page' => $_GET['q'])), WATCHDOG_WARNING);
Dries Buytaert's avatar
   
Dries Buytaert committed
322

323
324
325
326
327
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

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

338
  if (empty($return)) {
339
    drupal_set_title(t('Page not found'));
Dries Buytaert's avatar
   
Dries Buytaert committed
340
  }
341
342
  // To conserve CPU and bandwidth, omit the blocks
  print theme('page', $return, FALSE);
Dries Buytaert's avatar
   
Dries Buytaert committed
343
}
Dries Buytaert's avatar
   
Dries Buytaert committed
344

Dries Buytaert's avatar
   
Dries Buytaert committed
345
346
347
348
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
349
  drupal_set_header('HTTP/1.0 403 Forbidden');
350
  watchdog('access denied', t('%page denied access.', array('%page' => $_GET['q'])), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries Buytaert's avatar
   
Dries Buytaert committed
351

352
353
354
355
356
  // Keep old path for reference
  if (!isset($_REQUEST['destination'])) {
    $_REQUEST['destination'] = $_GET['q'];
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
357
  $path = drupal_get_normal_path(variable_get('site_403', ''));
358
  if ($path && $path != $_GET['q']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
359
    menu_set_active_item($path);
360
    $return = menu_execute_active_handler();
Dries Buytaert's avatar
   
Dries Buytaert committed
361
  }
362
  else {
363
    // Redirect to a non-existent menu item to make possible tabs disappear.
364
    menu_set_active_item('');
365
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
366

367
  if (empty($return)) {
368
    drupal_set_title(t('Access denied'));
369
    $return = t('You are not authorized to access this page.');
Dries Buytaert's avatar
   
Dries Buytaert committed
370
  }
371
  print theme('page', $return);
Dries Buytaert's avatar
   
Dries Buytaert committed
372
373
}

Dries Buytaert's avatar
   
Dries Buytaert committed
374
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
375
 * Perform an HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
376
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 * 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 Buytaert's avatar
   
Dries Buytaert committed
394
395
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries Buytaert's avatar
   
Dries Buytaert committed
396
397
  $result = new StdClass();

Dries Buytaert's avatar
   
Dries Buytaert committed
398
  // Parse the URL, and make sure we can handle the schema.
Dries Buytaert's avatar
   
Dries Buytaert committed
399
400
401
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
402
      $port = isset($uri['port']) ? $uri['port'] : 80;
403
      $host = $uri['host'] . ($port != 80 ? ':'. $port : '');
404
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries Buytaert's avatar
   
Dries Buytaert committed
405
406
      break;
    case 'https':
Dries Buytaert's avatar
   
Dries Buytaert committed
407
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
408
      $port = isset($uri['port']) ? $uri['port'] : 443;
409
      $host = $uri['host'] . ($port != 443 ? ':'. $port : '');
410
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries Buytaert's avatar
   
Dries Buytaert committed
411
412
      break;
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
413
      $result->error = 'invalid schema '. $uri['scheme'];
Dries Buytaert's avatar
   
Dries Buytaert committed
414
415
416
      return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
417
  // Make sure the socket opened properly.
Dries Buytaert's avatar
   
Dries Buytaert committed
418
  if (!$fp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
419
    $result->error = trim($errno .' '. $errstr);
Dries Buytaert's avatar
   
Dries Buytaert committed
420
421
422
    return $result;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
423
  // Construct the path to act on.
424
425
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries Buytaert's avatar
   
Dries Buytaert committed
426
    $path .= '?'. $uri['query'];
Dries Buytaert's avatar
   
Dries Buytaert committed
427
428
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
429
  // Create HTTP request.
Dries Buytaert's avatar
   
Dries Buytaert committed
430
  $defaults = array(
431
432
433
434
    // 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",
435
    'User-Agent' => 'User-Agent: Drupal (+http://drupal.org/)',
436
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries Buytaert's avatar
   
Dries Buytaert committed
437
438
439
  );

  foreach ($headers as $header => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
440
    $defaults[$header] = $header .': '. $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
441
442
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
443
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
444
445
446
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries Buytaert's avatar
   
Dries Buytaert committed
447
    $request .= $data ."\r\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
448
449
450
451
452
453
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
454
  $response = '';
455
456
  while (!feof($fp) && $chunk = fread($fp, 1024)) {
    $response .= $chunk;
Dries Buytaert's avatar
   
Dries Buytaert committed
457
458
459
460
  }
  fclose($fp);

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

464
  list($protocol, $code, $text) = explode(' ', trim(array_shift($split)), 3);
Dries Buytaert's avatar
   
Dries Buytaert committed
465
466
467
  $result->headers = array();

  // Parse headers.
468
  while ($line = trim(array_shift($split))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
469
    list($header, $value) = explode(':', $line, 2);
470
471
472
473
474
475
476
477
    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 Buytaert's avatar
   
Dries Buytaert committed
478
479
480
481
482
483
484
485
486
487
  }

  $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 Buytaert's avatar
   
Dries Buytaert committed
488
  // the base code in their class.
Dries Buytaert's avatar
   
Dries Buytaert committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
  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 Buytaert's avatar
   
Dries Buytaert committed
516
517
518
/**
 * @} End of "HTTP handling".
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
519

Dries Buytaert's avatar
   
Dries Buytaert committed
520
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
521
522
 * Log errors as defined by administrator
 * Error levels:
523
524
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries Buytaert's avatar
   
Dries Buytaert committed
525
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
526
function error_handler($errno, $message, $filename, $line) {
527
528
529
530
531
  // If the @ error suppression operator was used, error_reporting is temporarily set to 0
  if (error_reporting() == 0) {
    return;
  }

532
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
533
534
    $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 Buytaert's avatar
   
Dries Buytaert committed
535

536
    // Force display of error messages in update.php
537
    if (variable_get('error_level', 1) == 1 || strstr($_SERVER['PHP_SELF'], 'update.php')) {
538
      drupal_set_message($entry, 'error');
Dries Buytaert's avatar
Dries Buytaert committed
539
    }
540
541

    watchdog('php', t('%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)), WATCHDOG_ERROR);
Dries Buytaert's avatar
   
Dries Buytaert committed
542
543
544
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
545
function _fix_gpc_magic(&$item) {
Dries Buytaert's avatar
Dries Buytaert committed
546
  if (is_array($item)) {
Kjartan Mannes's avatar
Kjartan Mannes committed
547
548
549
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan Mannes's avatar
Kjartan Mannes committed
550
    $item = stripslashes($item);
Dries Buytaert's avatar
   
Dries Buytaert committed
551
552
553
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
554
555
556
557
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
558
function fix_gpc_magic() {
559
  static $fixed = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
560
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries Buytaert's avatar
Dries Buytaert committed
561
562
563
564
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
565
    $fixed = TRUE;
Dries Buytaert's avatar
Dries Buytaert committed
566
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
567
568
}

Dries Buytaert's avatar
   
Dries Buytaert committed
569
570
571
/**
 * Initialize the localization system.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
572
573
function locale_initialize() {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
574
575
576
577
578

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

Dries Buytaert's avatar
   
Dries Buytaert committed
579
580
581
582
583
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
584
585
586
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
Dries Buytaert's avatar
   
Dries Buytaert committed
587
  }
588
  if ($user->uid && isset($languages[$user->language])) {
Dries Buytaert's avatar
   
Dries Buytaert committed
589
590
591
592
593
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
594
595
}

596
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
597
 * Translate strings to the current locale.
598
 *
599
 * When using t(), try to put entire sentences and strings in one t() call.
Dries Buytaert's avatar
   
Dries Buytaert committed
600
601
602
603
 * This makes it easier for translators. HTML markup within translation strings
 * is acceptable, if necessary. The suggested syntax for a link embedded
 * within a translation string is:
 * @code
604
605
 *   $msg = t('You must log in below or <a href="@url">create a new
 *             account</a> before viewing the next page.', array('@url'
Dries Buytaert's avatar
   
Dries Buytaert committed
606
 *             => url('user/register')));
Dries Buytaert's avatar
   
Dries Buytaert committed
607
 * @endcode
608
609
610
 * We suggest the same syntax for links to other sites. This makes it easy to
 * change link URLs if needed (which happens often) without requiring updates
 * to translations.
611
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
612
 * @param $string
Dries Buytaert's avatar
   
Dries Buytaert committed
613
 *   A string containing the English string to translate.
Dries Buytaert's avatar
   
Dries Buytaert committed
614
615
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries Buytaert's avatar
   
Dries Buytaert committed
616
 *   of any key in this array are replaced with the corresponding value.
617
618
619
620
621
 *   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)
Dries Buytaert's avatar
   
Dries Buytaert committed
622
623
 * @return
 *   The translated string.
624
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
625
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
626
627
628
629
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
630
631
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
632
633
  }
  else {
634
635
    // Transform arguments before inserting them
    array_walk($args, '_t');
Dries Buytaert's avatar
   
Dries Buytaert committed
636
637
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
638
639
}

640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
/**
 * Helper function: apply the appropriate transformation to st() and t()
 * placeholders.
 */
function _t(&$value, $key) {
  switch ($key[0]) {
    // Escaped only
    case '@':
      $value = check_plain($value);
      return;
    // Escaped and placeholder
    case '%':
    default:
      $value = theme('placeholder', $value);
      return;
Steven Wittens's avatar
Steven Wittens committed
655
656
    // Pass-through
    case '!':
657
658
659
  }
}

660
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
661
 * @defgroup validation Input validation
Dries Buytaert's avatar
   
Dries Buytaert committed
662
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
663
 * Functions to validate user input.
664
665
 */

666
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
667
668
669
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
670
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
671
 * @param $mail
672
 *   A string containing an e-mail address.
Dries Buytaert's avatar
   
Dries Buytaert committed
673
 * @return
Dries Buytaert's avatar
   
Dries Buytaert committed
674
 *   TRUE if the address is in a valid format.
675
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
676
function valid_email_address($mail) {
677
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
678
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
679
680
681
  $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 Buytaert's avatar
Dries Buytaert committed
682
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
683
684
}

Dries Buytaert's avatar
   
Dries Buytaert committed
685
686
687
/**
 * Verify the syntax of the given URL.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
688
 * @param $url
Dries Buytaert's avatar
   
Dries Buytaert committed
689
 *   The URL to verify.
Dries Buytaert's avatar
   
Dries Buytaert committed
690
 * @param $absolute
Dries Buytaert's avatar
   
Dries Buytaert committed
691
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries Buytaert's avatar
   
Dries Buytaert committed
692
 * @return
Dries Buytaert's avatar
   
Dries Buytaert committed
693
 *   TRUE if the URL is in a valid format.
Dries Buytaert's avatar
   
Dries Buytaert committed
694
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
695
function valid_url($url, $absolute = FALSE) {
696
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
697
  if ($absolute) {
698
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
699
700
  }
  else {
701
    return preg_match("/^". $allowed_characters ."+$/i", $url);
702
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
703
704
}

Dries Buytaert's avatar
   
Dries Buytaert committed
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
/**
 * 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
725
 *   True if the user did not exceed the hourly threshold. False otherwise.
Dries Buytaert's avatar
   
Dries Buytaert committed
726
727
728
729
730
731
 */
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);
}

732
733
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
734
735
}

736
737
738
739
740
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
741
  return filter_xss_bad_protocol($uri, FALSE);
742
743
}

Dries Buytaert's avatar
   
Dries Buytaert committed
744
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
745
 * @defgroup format Formatting
Dries Buytaert's avatar
   
Dries Buytaert committed
746
 * @{
Dries Buytaert's avatar
   
Dries Buytaert committed
747
 * Functions to format numbers, strings, dates, etc.
Dries Buytaert's avatar
   
Dries Buytaert committed
748
749
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
750
751
752
753
754
755
/**
 * 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 Buytaert's avatar
   
Dries Buytaert committed
756
757
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
Dries Buytaert committed
758
  $output = "<channel>\n";
759
760
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
761
762
763
764
765

  // 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";
766
  $output .= ' <language>'. check_plain($language) ."</language>\n";
767
  $output .= format_xml_elements($args);
Dries Buytaert's avatar
   
Dries Buytaert committed
768
769
770
771
772
773
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
774
775
776
777
778
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
779
function format_rss_item($title, $link, $description, $args = array()) {
Dries Buytaert's avatar
Dries Buytaert committed
780
  $output = "<item>\n";
781
782
783
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
  $output .= format_xml_elements($args);
  $output .= "</item>\n";

  return $output;
}

/**
 * Format XML elements.
 *
 * @param $array
 *   An array where each item represent an element and is either a:
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
 *     - 'key': element name
 *     - 'value': element contents
 *     - 'attributes': associative array of element attributes
 *
 * In both cases, 'value' can be a simple string, or it can be another array
 * with the same format as $array itself for nesting.
 */
function format_xml_elements($array) {
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
807
808
      if ($value['key']) {
        $output .= ' <'. $value['key'];
809
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries Buytaert's avatar
   
Dries Buytaert committed
810
811
812
          $output .= drupal_attributes($value['attributes']);
        }

813
        if ($value['value'] != '') {
814
          $output .= '>'. (is_array($value['value']) ? format_xml_elements($value['value']) : check_plain($value['value'])) .'</'. $value['key'] .">\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
815
816
817
818
819
820
821
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
822
      $output .= ' <'. $key .'>'. (is_array($value) ? format_xml_elements($value) : check_plain($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
823
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
824
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
825
826
827
  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
828
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
829
 * Format a string containing a count of items.
Dries Buytaert's avatar
   
Dries Buytaert committed
830
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
831
832
833
834
835
836
837
838
839
840
 * This function ensures that the string is pluralized correctly. Since t() is
 * called by this function, make sure not to pass already-localized strings to it.
 *
 * @param $count
 *   The item count to display.
 * @param $singular
 *   The string for the singular case. Please make sure it is clear this is
 *   singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
841
 *   to ease translation. Use @count in place of the item count, as in "@count
Dries Buytaert's avatar
   
Dries Buytaert committed
842
843
844
 *   new comments".
 * @return
 *   A translated string.
Dries Buytaert's avatar
   
Dries Buytaert committed
845
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
846
function format_plural($count, $singular, $plural) {
847
  if ($count == 1) return t($singular, array("@count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
848
849

  // get the plural index through the gettext formula
850
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries Buytaert's avatar
   
Dries Buytaert committed
851
  if ($index < 0) { // backward compatibility
852
    return t($plural, array("@count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
853
854
855
856
  }
  else {
    switch ($index) {
      case "0":
857
        return t($singular, array("@count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
858
      case "1":
859
        return t($plural, array("@count" => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
860
      default:
861
        return t(strtr($plural, array("@count" => '@count['. $index .']')), array('@count['. $index .']' => $count));
Dries Buytaert's avatar
   
Dries Buytaert committed
862
863
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
864
865
}

Dries Buytaert's avatar
   
Dries Buytaert committed
866
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
867
 * Generate a string representation for the given byte count.
Dries Buytaert's avatar
   
Dries Buytaert committed
868
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
869
870
871
872
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries Buytaert's avatar
   
Dries Buytaert committed
873
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
874
function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
875
  $suffix = t('bytes');
876
  if ($size >= 1024) {
Dries Buytaert's avatar
   
Dries Buytaert committed
877
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
878
    $suffix = t('KB');
Dries Buytaert's avatar
   
Dries Buytaert committed
879
  }
880
  if ($size >= 1024) {
Dries Buytaert's avatar
   
Dries Buytaert committed
881
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
882
    $suffix = t('MB');
Dries Buytaert's avatar
   
Dries Buytaert committed
883
  }
884
  return t('@size @suffix', array('@size' => $size, '@suffix' => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
885
886
}

Dries Buytaert's avatar
   
Dries Buytaert committed
887
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
888
 * Format a time interval with the requested granularity.
Dries Buytaert's avatar
   
Dries Buytaert committed
889
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
890
891
892
893
894
895
 * @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 Buytaert's avatar
   
Dries Buytaert committed
896
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
897
function format_interval($timestamp, $granularity = 2) {
898
  $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 Buytaert's avatar
   
Dries Buytaert committed
899
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
900
  foreach ($units as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
901
    $key = explode('|', $key);
Dries Buytaert's avatar
   
Dries Buytaert committed
902
    if ($timestamp >= $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
903
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries Buytaert's avatar
   
Dries Buytaert committed
904
      $timestamp %= $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
905
906
907
908
909
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
910
911
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
912
  return $output ? $output : t('0 sec');
Dries Buytaert's avatar
   
Dries Buytaert committed
913
914
}

Dries Buytaert's avatar
   
Dries Buytaert committed
915
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
916
917
 * Format a date with the given configured format or a custom format string.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
918
919
920
921
 * 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 Buytaert's avatar
   
Dries Buytaert committed
922
923
924
925
926
927
 * @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
928
929
930
 *   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 Buytaert's avatar
   
Dries Buytaert committed
931
932
933
934
 * @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 Buytaert's avatar
   
Dries Buytaert committed
935
 */
936
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
937
  if (!isset($timezone)) {
938
    global $user;
Steven Wittens's avatar
Steven Wittens committed
939
940
941
942
943
944
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
945
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
946

947
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
948
949

  switch ($type) {
950
951
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
952
      break;
953
954
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
955
      break;
956
    case 'custom':
Dries Buytaert's avatar
   
Dries Buytaert committed
957
      // No change to format
Dries Buytaert's avatar
   
Dries Buytaert committed
958
      break;
959
    case 'medium':
Dries Buytaert's avatar
   
Dries Buytaert committed
960
    default:
961
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries Buytaert's avatar
   
Dries Buytaert committed
962
963
  }

964
  $max = strlen($format);
Dries Buytaert's avatar
   
Dries Buytaert committed
965
  $date = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
966
  for ($i = 0; $i < $max; $i++) {
967
    $c = $format[$i];
968
    if (strpos('AaDFlM', $c) !== FALSE) {
969
      $date .= t(gmdate($c, $timestamp));
970
    }
971
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== FALSE) {
972
973
974
975
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries Buytaert's avatar
   
Dries Buytaert committed
976
    }
977
978
979
980
981
    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 Buytaert's avatar
   
Dries Buytaert committed
982
    }
983
984
985
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
986
    else {
987
      $date .= $c;
Dries Buytaert's avatar
   
Dries Buytaert committed